Update Guide

Signed-off-by: breakdowns <hafitz666@outlook.co.id>
This commit is contained in:
Hafitz Setya 2021-08-22 08:12:41 +07:00 committed by GitHub
parent 311f83375e
commit b6738a318c
Signed by untrusted user: GitHub
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,13 +2,14 @@
## Pre-requisites
- [token.pickle](https://github.com/Slam-Team/slam-mirrorbot#getting-google-oauth-api-credential-file)
- [Heroku](heroku.com) accounts
- Recommended to use 1 App in 1 Heroku accounts
- Don't use bin/fake credits card, because your Heroku account will banned
## Deployment
1. Give stars and Fork this repo then upload **token.pickle** to your forks, or you can upload your **token.pickle** to your Index and put your **token.pickle** link to **TOKEN_PICKLE_URL** (**NOTE**: If you didn't upload **token.pickle** uploading will not work). How to generate **token.pickle**? [Read here](https://github.com/Slam-Team/slam-mirrorbot#getting-google-oauth-api-credential-file)
1. Give stars and Fork this repo then upload **token.pickle** to your forks, or you can upload your **token.pickle** to your Index and put your **token.pickle** link to **TOKEN_PICKLE_URL** (**NOTE**: If you didn't upload **token.pickle** uploading will not work).
2. Go to Repository `Settings` -> `Secrets`
@ -16,19 +17,16 @@
3. Add the below Required Variables one by one by clicking `New Repository Secret` everytime.
```
HEROKU_EMAIL
HEROKU_API_KEY
HEROKU_APP_NAME
CONFIG_FILE_URL
```
- To get CONFIG_FILE_URL, check the steps here:
* `HEROKU_EMAIL` Heroku Account email Id in which the above app will be deployed
* `HEROKU_API_KEY` Your Heroku API key, get it from https://dashboard.heroku.com/account
* `HEROKU_APP_NAME` Your Heroku app name, Name Must be unique
* `CONFIG_FILE_URL` You must upload your `config.env` to https://gist.github.com, Check the steps here:
![steps 1 to 3](https://telegra.ph/file/1d8fec16516a87ba9d1ac.jpg)
![steps 1 to 3](https://telegra.ph/file/1d8fec16516a87ba9d1ac.jpg)
![step 4](https://telegra.ph/file/1491f99836cd694ea1195.jpg)
![step 4](https://telegra.ph/file/1491f99836cd694ea1195.jpg)
![step 5](https://telegra.ph/file/416a550f7ded579b63272.jpg)
![step 5](https://telegra.ph/file/416a550f7ded579b63272.jpg)
4. After adding all the above Required Variables go to Github Actions tab in your repo
@ -43,8 +41,7 @@
7. _Done!_ your bot will be deployed now.
## NOTE
- Don't change/edit variables from Heroku if you want to change/edit do it from Github Secrets
- If you want to set optional variables, go to your Heroku app settings and add the variables
- Don't change/edit variables from Heroku if you want to change/edit do it from `config.env`
## Credits
- [arghyac35](https://github.com/arghyac35) for Tutorial