OpenSourceArk
/
vas3k.club
mirror of https://github.com/vas3k/vas3k.club.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update .env.example

This commit is contained in:
vas3k 2021-05-12 10:12:48 +03:00
parent 9cbb1f0ed8
commit 9bedcd3185
3 changed files with 40 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -47,7 +47,7 @@ The first time you start it up, you'll probably need a test account to get right
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`.
## 🧑‍💻 Advanced setup for pro
## 🧑‍💻 Advanced setup for devs
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).

42
club/.env.example
View File

@ -1,19 +1,29 @@
# Patreon settings:
SECRET_KEY="salt_for_cookies"
MEDIA_UPLOAD_URL="https://i.vas3k.club/upload/"
MEDIA_UPLOAD_CODE="the_secret_passphrase"
EMAIL_HOST_USER="smtp_server_username"
EMAIL_HOST_PASSWORD="smtp_server_password"
TELEGRAM_TOKEN="token_for_telegram_bot"
TELEGRAM_BOT_URL="https://t.me/00000000000"
TELEGRAM_ADMIN_CHAT_ID="-1000000000000"
TELEGRAM_CLUB_CHANNEL_URL="https://t.me/vas3k_club"
TELEGRAM_CLUB_CHANNEL_ID="-10000000000"
TELEGRAM_CLUB_CHAT_URL="https://t.me/joinchat/00000000000"
TELEGRAM_CLUB_CHAT_ID="-1000000000000"
TELEGRAM_ONLINE_CHANNEL_URL="https://t.me/joinchat/0000000000"
TELEGRAM_ONLINE_CHANNEL_ID="-10000000000"
SENTRY_DSN=""
STRIPE_API_KEY=""
STRIPE_PUBLIC_KEY=""
STRIPE_WEBHOOK_SECRET=""
PATREON_CLIENT_ID=""
PATREON_CLIENT_SECRET=""
# Telegram bot settings:
TELEGRAM_TOKEN=""
TELEGRAM_BOT_URL=""
TELEGRAM_ADMIN_CHAT_ID=""
TELEGRAM_CLUB_CHANNEL_URL=""
TELEGRAM_CLUB_CHANNEL_ID=""
TELEGRAM_CLUB_CHAT_URL=""
TELEGRAM_CLUB_CHAT_ID=""
TELEGRAM_ONLINE_CHANNEL_URL=""
TELEGRAM_ONLINE_CHANNEL_ID=""
# Others:
SECRET_KEY="" #TODO @vas3k, what is that key for? -> to encode cookies and csrf tokens
JWT_SECRET=""
MEDIA_UPLOAD_CODE=""
JWT_PRIVATE_KEY=""
WEBHOOK_SECRETS=""

26
docs/setup.md
View File

@ -1,18 +1,5 @@
# Advanced Setup
## Telegram bot
To run telegram bot you have to:
1. Copy env.exmaple file: `cp ./club/.env.example ./club/.env`
2. Fill all the requirement fields in `./club/env`, such as `TELEGRAM_TOKEN` etc.
- `TELEGRAM_TOKEN` you can get from [@BotFather](https://t.me/BotFather)
- 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)
3. Rebuild application: `docker-compose up --build`
## Docker-compose
Check out our [docker-compose.yml](https://github.com/vas3k/vas3k.club/blob/master/docker-compose.yml) to understand the infrastructure.
## Local development
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
# run dev server
$ pipenv run python manage.py runserver 0.0.0.0:8000
```
## Telegram bot
To run telegram bot you have to:
1. Copy env.exmaple file: `cp ./club/.env.example ./club/.env`
2. Fill all the requirement fields in `./club/env`, such as `TELEGRAM_TOKEN` etc.
- `TELEGRAM_TOKEN` you can get from [@BotFather](https://t.me/BotFather)
- 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)
3. Rebuild application: `docker-compose up --build`
## Docker-compose
Check out our [docker-compose.yml](https://github.com/vas3k/vas3k.club/blob/master/docker-compose.yml) to understand the infrastructure.