Skip to content
This repository was archived by the owner on Nov 5, 2025. It is now read-only.

Commit 957b24c

Browse files
LilianbazantaySigmanificient
authored andcommitted
refactor(readme): update config exemple
1 parent 2fc4354 commit 957b24c

File tree

2 files changed

+53
-8
lines changed

2 files changed

+53
-8
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,12 @@ The system is composed of three main parts:
4444

4545
### Installation
4646

47-
- **Step 1**: Go to back and a create a \`config.toml\` file. Fill it based on the data in exemples/exemple_config. In the provider section, replace the client_id and client_secret with your client_id and client_secret. Repeat for every provider. (They can be found in back/app/routes)
47+
- **Step 1**: Go to back and a create a \`config.toml\` file. Fill it based on the data in exemples/exemple_config:
48+
The `jwt_secret` is an ascii string.
49+
For each routes fill the `client_id` and `client_secret` with your own.
50+
Note for caldav/gmail/youtube, use the same `client_id`/`client_secret`. The `client_id` must finish with `.apps.googleusercontent.com`.
51+
52+
In the provider section, replace the client_id and client_secret with your client_id and client_secret. Repeat for every provider. (They can be found in back/app/routes)
4853

4954
- **Step 2**: Go to front/android and create a \`gradle.properties\` file. Fill it with the informations in exemples/exemple_gradle. Fill `RELEASE_STORE_PASSWORD` and `RELEASE_KEY_PASSWORD` with your own password. The two must have an identical one.
5055

exemples/exemple_config

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,54 @@
11
[security]
2-
jwt_secret = "hello_world_3301@083280948390"
2+
jwt_secret = ""
33

44
[db]
55
uri="sqlite+aiosqlite:///app.db"
66

7-
[providers]
87

9-
[providers.discord]
10-
client_id = id_exemple #1418965246885761106
11-
client_secret = secret_example #"JgGHjCxByc56UweRxbS978hWq9tpRbs4"
8+
[routes.discord]
9+
client_id = ""
10+
client_secret = ""
1211

13-
[providers.github]
14-
\# ...
12+
[routes.spotify]
13+
# scope = "user-read-email user-read-currently-playing user-follow-read"
14+
client_id = ""
15+
client_secret = ""
16+
17+
[routes.gmail]
18+
# Provide your Google OAuth 2.0 Web client credentials
19+
# Ensure the redirect URI http://127.0.0.1:8080/gmail/auth is added in Google Cloud Console
20+
client_id = ""
21+
client_secret = ""
22+
# Optional: override scope or redirect URI here if needed
23+
# scope = "https://www.googleapis.com/auth/gmail.readonly openid email profile"
24+
# redirect_uri = "http://127.0.0.1:8080/gmail/auth"
25+
26+
[routes.caldav]
27+
# Uses Google OAuth credentials (you can reuse the same client as Gmail/YouTube)
28+
# Add redirect URI: http://127.0.0.1:8080/caldav/auth
29+
client_id = ""
30+
client_secret = ""
31+
# Optional overrides
32+
# scope = "https://www.googleapis.com/auth/calendar.readonly openid email profile"
33+
# redirect_uri = "http://127.0.0.1:8080/caldav/auth"
34+
35+
[routes.youtube]
36+
# Create OAuth credentials at https://console.cloud.google.com/apis/credentials
37+
# Add http://127.0.0.1:8080/youtube/auth as an authorized redirect URI
38+
client_id = "-."
39+
client_secret = ""
40+
# Optional overrides
41+
# scope = "https://www.googleapis.com/auth/youtube.readonly openid email profile"
42+
# redirect_uri = "http://127.0.0.1:8080/youtube/auth"
43+
44+
[routes.reddit]
45+
# Create a Reddit app at https://www.reddit.com/prefs/apps
46+
# For local dev, use type: installed app (or web app) and add redirect URI:
47+
# http://127.0.0.1:8080/reddit/auth
48+
# Note: Installed apps have no secret; keep client_secret empty. Web apps have a secret.
49+
client_id = ""
50+
client_secret = ""
51+
# Optional overrides:
52+
# scope = "identity read"
53+
# redirect_uri = "http://127.0.0.1:8080/reddit/auth"
54+
# resource_headers.User-Agent should be descriptive; override via code if needed

0 commit comments

Comments
 (0)