Skip to content

Commit 9bedcd3

Browse files
committed
Update .env.example
1 parent 9cbb1f0 commit 9bedcd3

File tree

3 files changed

+40
-30
lines changed

3 files changed

+40
-30
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The first time you start it up, you'll probably need a test account to get right
4747
4848
Auto-reloading for backend and frontend is performed automatically on every code change. If everything is broken and not working (it happens), you can always rebuild the world from scratch using `docker-compose up --build`.
4949
50-
## 🧑‍💻 Advanced setup for pro
50+
## 🧑‍💻 Advanced setup for devs
5151
5252
For more information on how to test the telegram bot, run project without docker and other useful notes, read [docs/setup.md](docs/setup.md).
5353

club/.env.example

+26-16
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
1-
# Patreon settings:
1+
SECRET_KEY="salt_for_cookies"
2+
3+
MEDIA_UPLOAD_URL="https://i.vas3k.club/upload/"
4+
MEDIA_UPLOAD_CODE="the_secret_passphrase"
5+
6+
EMAIL_HOST_USER="smtp_server_username"
7+
EMAIL_HOST_PASSWORD="smtp_server_password"
8+
9+
TELEGRAM_TOKEN="token_for_telegram_bot"
10+
TELEGRAM_BOT_URL="https://t.me/00000000000"
11+
TELEGRAM_ADMIN_CHAT_ID="-1000000000000"
12+
TELEGRAM_CLUB_CHANNEL_URL="https://t.me/vas3k_club"
13+
TELEGRAM_CLUB_CHANNEL_ID="-10000000000"
14+
TELEGRAM_CLUB_CHAT_URL="https://t.me/joinchat/00000000000"
15+
TELEGRAM_CLUB_CHAT_ID="-1000000000000"
16+
TELEGRAM_ONLINE_CHANNEL_URL="https://t.me/joinchat/0000000000"
17+
TELEGRAM_ONLINE_CHANNEL_ID="-10000000000"
18+
19+
SENTRY_DSN=""
20+
21+
STRIPE_API_KEY=""
22+
STRIPE_PUBLIC_KEY=""
23+
STRIPE_WEBHOOK_SECRET=""
24+
225
PATREON_CLIENT_ID=""
326
PATREON_CLIENT_SECRET=""
427

5-
# Telegram bot settings:
6-
TELEGRAM_TOKEN=""
7-
TELEGRAM_BOT_URL=""
8-
TELEGRAM_ADMIN_CHAT_ID=""
9-
TELEGRAM_CLUB_CHANNEL_URL=""
10-
TELEGRAM_CLUB_CHANNEL_ID=""
11-
TELEGRAM_CLUB_CHAT_URL=""
12-
TELEGRAM_CLUB_CHAT_ID=""
13-
TELEGRAM_ONLINE_CHANNEL_URL=""
14-
TELEGRAM_ONLINE_CHANNEL_ID=""
15-
16-
# Others:
17-
SECRET_KEY="" #TODO @vas3k, what is that key for? -> to encode cookies and csrf tokens
18-
JWT_SECRET=""
19-
MEDIA_UPLOAD_CODE=""
28+
JWT_PRIVATE_KEY=""
29+
WEBHOOK_SECRETS=""

docs/setup.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
11
# Advanced Setup
22

3-
## Telegram bot
4-
5-
To run telegram bot you have to:
6-
1. Copy env.exmaple file: `cp ./club/.env.example ./club/.env`
7-
2. Fill all the requirement fields in `./club/env`, such as `TELEGRAM_TOKEN` etc.
8-
- `TELEGRAM_TOKEN` you can get from [@BotFather](https://t.me/BotFather)
9-
- To get `TELEGRAM_CLUB_CHANNEL_URL`, `TELEGRAM_ADMIN_CHAT_ID` etc Just Simply Forward a message from your group/channel to [@JsonDumpBot](https://t.me/JsonDumpBot) or [@getidsbot](https://t.me/getidsbot)
10-
3. Rebuild application: `docker-compose up --build`
11-
12-
## Docker-compose
13-
14-
Check out our [docker-compose.yml](https://github.com/vas3k/vas3k.club/blob/master/docker-compose.yml) to understand the infrastructure.
15-
163
## Local development
174

185
Once you decided to code something in the project you'll need to setup your environment. Here's how you can make it.
@@ -87,3 +74,16 @@ $ pipenv run python manage.py migrate
8774
# run dev server
8875
$ pipenv run python manage.py runserver 0.0.0.0:8000
8976
```
77+
78+
## Telegram bot
79+
80+
To run telegram bot you have to:
81+
1. Copy env.exmaple file: `cp ./club/.env.example ./club/.env`
82+
2. Fill all the requirement fields in `./club/env`, such as `TELEGRAM_TOKEN` etc.
83+
- `TELEGRAM_TOKEN` you can get from [@BotFather](https://t.me/BotFather)
84+
- To get `TELEGRAM_CLUB_CHANNEL_URL`, `TELEGRAM_ADMIN_CHAT_ID` etc Just Simply Forward a message from your group/channel to [@JsonDumpBot](https://t.me/JsonDumpBot) or [@getidsbot](https://t.me/getidsbot)
85+
3. Rebuild application: `docker-compose up --build`
86+
87+
## Docker-compose
88+
89+
Check out our [docker-compose.yml](https://github.com/vas3k/vas3k.club/blob/master/docker-compose.yml) to understand the infrastructure.

0 commit comments

Comments
 (0)