Skip to content

Commit 5b2d00a

Browse files
committed
Minor fixes
1 parent 93e3268 commit 5b2d00a

File tree

2 files changed

+28
-31
lines changed

2 files changed

+28
-31
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ pyenv activate hyperion
8484

8585
### About Jellyfish and Rust
8686

87-
If you don't have Rust installed or don't want to install it, decrase the version of `jellyfish` to `0.10.0` in the `requirements-common.txt` file:
87+
If you don't have Rust installed or don't want to install it, decrease the version of `jellyfish` to `0.10.0` in the `requirements-common.txt` file:
8888

8989
```
9090
jellyfish==0.10.0 # String Matching
@@ -282,10 +282,8 @@ POSTGRES_DB="hyperion"
282282

283283
The `config.yaml` contains environment variables that are internal to the Python runtime _because_ they are only used in the Python code.
284284

285-
1. `ACCESS_TOKEN_SECRET_KEY`: **Uncomment it**.
286-
You can generate your own if you want, or just change a couple characters, or leave it as it is.
287-
2. `RSA_PRIVATE_PEM_STRING`: **Uncomment it**.
288-
You can generate your own if you want, or just change a couple characters, or leave it as it is.
285+
1. `ACCESS_TOKEN_SECRET_KEY`: You can generate your own if you want, or just change a couple characters, or leave it as it is.
286+
2. `RSA_PRIVATE_PEM_STRING`: You can generate your own if you want, or just change a couple characters, or leave it as it is.
289287
3. `SQLITE_DB`: **tells Hyperion whether to use SQLite or PostgreSQL**.
290288
- If you use **SQLite**: this field should be a (relative) filename, by default we named it `app.db`, you can change this name.
291289
Hyperion will create this file for you and use it as the database.

config.template.yaml

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ CLIENT_URL: http://127.0.0.1:8000/ # NOTE: A trailing / is required
4747
# For exemple:
4848
# - you will access the login page from your browser http://localhost:8000/auth/authorize
4949
# - but the docker container should call http://host.docker.internal:8000/auth/token and not your localhost address
50-
#OVERRIDDEN_CLIENT_URL_FOR_OIDC: "http://host.docker.internal:8000/" # NOTE: A trailing / is required
50+
#OVERRIDDEN_CLIENT_URL_FOR_OIDC: http://host.docker.internal:8000/ # NOTE: A trailing / is required
5151

5252
# Origins for the CORS middleware. `["http://localhost:3000"]` can be used for development.
5353
# See https://fastapi.tiangolo.com/tutorial/cors/
@@ -81,7 +81,7 @@ AUTH_CLIENTS:
8181
- http://localhost:3000/static.html
8282
- http://127.0.0.1:3000/static.html
8383
- https://myecl.fr/static.html
84-
- "fr.myecl.titan://authorized
84+
- fr.myecl.titan://authorized
8585
auth_client: AppAuthClient
8686
Postman:
8787
secret: PostmanSecret
@@ -147,10 +147,10 @@ FACTORIES_DEMO_USERS:
147147

148148
SMTP_ACTIVE: False
149149
SMTP_PORT: 587
150-
SMTP_SERVER: ""
151-
SMTP_USERNAME: ""
152-
SMTP_PASSWORD: ""
153-
SMTP_EMAIL: ""
150+
SMTP_SERVER:
151+
SMTP_USERNAME:
152+
SMTP_PASSWORD:
153+
SMTP_EMAIL:
154154

155155
##########################
156156
# Firebase Configuration #
@@ -159,7 +159,6 @@ SMTP_EMAIL: ""
159159
# To enable Firebase push notification capabilities, a JSON key file named `firebase.json` should be placed at Hyperion root.
160160
# This file can be created and downloaded from [Google cloud, IAM and administration, Service account](https://console.cloud.google.com/iam-admin/serviceaccounts) page.
161161
USE_FIREBASE: False
162-
163162
########################
164163
# Matrix configuration #
165164
########################
@@ -169,28 +168,28 @@ USE_FIREBASE: False
169168
# If the following parameters are not set, logging won't use the Matrix handler
170169
# MATRIX_SERVER_BASE_URL is optional, the official Matrix server will be used if not configured
171170
# Advanced note: Username and password will be used to ask for an access token. A Matrix custom client `Hyperion` is used to make all requests
172-
#MATRIX_SERVER_BASE_URL: "https://matrix.example.org/"
173-
#MATRIX_TOKEN: "mct_..."
174-
#MATRIX_LOG_ERROR_ROOM_ID: "!...:myecl.fr"
175-
#MATRIX_LOG_AMAP_ROOM_ID: ""
171+
#MATRIX_SERVER_BASE_URL: https://matrix.example.org/
172+
#MATRIX_TOKEN: mct_...
173+
#MATRIX_LOG_ERROR_ROOM_ID: !...:myecl.fr
174+
#MATRIX_LOG_AMAP_ROOM_ID:
176175

177176
#############################
178177
# Token to use the TMDB API #
179178
#############################
180179

181180
# This API key is required in order to send requests to the Internet Movie Database.
182181
# It is only used in the Cinema module.
183-
#THE_MOVIE_DB_API: ""
182+
#THE_MOVIE_DB_API:
184183

185184
####################
186185
# S3 configuration #
187186
####################
188187

189188
# S3 configuration is needed to use the S3 storage for MyECLPay logs
190189

191-
#S3_BUCKET_NAME: ""
192-
#S3_ACCESS_KEY_ID: ""
193-
#S3_SECRET_ACCESS_KEY: ""
190+
#S3_BUCKET_NAME:
191+
#S3_ACCESS_KEY_ID:
192+
#S3_SECRET_ACCESS_KEY:
194193

195194
##############
196195
# Google API #
@@ -199,14 +198,14 @@ USE_FIREBASE: False
199198
# Google API configuration #
200199
# Google API is used to upload files to Google Drive
201200
# See ./app/utils/google_api/README.md for more information
202-
#GOOGLE_API_CLIENT_ID: ""
203-
#GOOGLE_API_CLIENT_SECRET: ""
201+
#GOOGLE_API_CLIENT_ID:
202+
#GOOGLE_API_CLIENT_SECRET:
204203

205-
#RAID_DRIVE_REFRESH_TOKEN: ""
206-
#RAID_DRIVE_API_KEY: ""
207-
#RAID_DRIVE_CLIENT_ID: ""
208-
#RAID_DRIVE_CLIENT_SECRET: ""
209-
#RAID_PAYMENT_REDIRECTION_URL: ""
204+
#RAID_DRIVE_REFRESH_TOKEN:
205+
#RAID_DRIVE_API_KEY:
206+
#RAID_DRIVE_CLIENT_ID:
207+
#RAID_DRIVE_CLIENT_SECRET:
208+
#RAID_PAYMENT_REDIRECTION_URL:
210209

211210
###########################
212211
# HelloAsso configuration #
@@ -217,13 +216,13 @@ USE_FIREBASE: False
217216
# HELLOASSO_API_BASE should have the format: `api.helloasso-sandbox.com`
218217
# HelloAsso only allow 20 simultaneous active access token. Note that each Hyperion worker will need its own access token.
219218

220-
#HELLOASSO_CONFIGURATIONS: # [["name", "helloasso_client_id", "helloasso_client_secret", "helloasso_slug", "redirection_uri"]]
219+
#HELLOASSO_CONFIGURATIONS:
221220
# MYECLPAY:
222221
# helloasso_client_id: ...
223222
# helloasso_client_secret: ...
224-
# helloasso_slug: "AEECL"
223+
# helloasso_slug: AEECL
225224
# redirection_uri: null
226-
#HELLOASSO_API_BASE: "api.helloasso-sandbox.com"
225+
#HELLOASSO_API_BASE: api.helloasso-sandbox.com
227226

228227
# Maximum wallet balance for MyECLPay in cents, we will prevent user from adding more money to their wallet if it will make their balance exceed this value
229228
#MYECLPAY_MAXIMUM_WALLET_BALANCE: 8000
@@ -236,4 +235,4 @@ USE_FIREBASE: False
236235
# MyECLPay requires an external service to recurrently check for transactions and state integrity, this service needs an access to all the data related to the transactions and the users involved
237236
# This service will use a special token to access the data
238237
# If this token is not set, the service will not be able to access the data and no integrity check will be performed
239-
#MYECLPAY_DATA_VERIFIER_ACCESS_TOKEN: ""
238+
#MYECLPAY_DATA_VERIFIER_ACCESS_TOKEN:

0 commit comments

Comments
 (0)