From b84d4aca2c8e52b67de800593e30bffb3c80992c Mon Sep 17 00:00:00 2001 From: lzzy12 Date: Sun, 5 Apr 2020 13:57:49 +0530 Subject: [PATCH] Update Documentation Signed-off-by: lzzy12 --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d5f4fa6..0e8d5b6 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,8 @@ This project is heavily inspired from @out386 's telegram bot which is written i - Docker support - Uploading To Team Drives. - Index Link support - +- Service account support # Upcoming features (TODOs): -- Mirror from Telegram files # How to deploy? Deploying is pretty much straight forward and is divided into several steps as follows: @@ -52,7 +51,8 @@ Fill up rest of the fields. Meaning of each fields are discussed below: - DOWNLOAD_STATUS_UPDATE_INTERVAL : A short interval of time in seconds after which the Mirror progress message is updated. (I recommend to keep it 5 seconds at least) - OWNER_ID : The Telegram user ID (not username) of the owner of the bot - AUTO_DELETE_MESSAGE_DURATION : Interval of time (in seconds), after which the bot deletes it's message (and command message) which is expected to be viewed instantly. Note: Set to -1 to never automatically delete messages -- IS_TEAM_DRIVE : (Optional field) Set to "True" if GDRIVE_FOLDER_ID is from a Team Drive else False or Leave it empty. +- IS_TEAM_DRIVE : (Optional field) Set to "True" if GDRIVE_FOLDER_ID is from a Team Drive else False or Leave it empty. +- USE_SERVICE_ACCOUNTS: (Optional field) (Leave empty if unsure) Whether to use service accounts or not. For this to work see "Using service accounts" section below. - INDEX_URL : (Optional field) Refer to https://github.com/maple3142/GDIndex/ The URL should not have any trailing '/' - API_KEY : This is to authenticate to your telegram account for downloading Telegram files. You can get this from https://my.telegram.org DO NOT put this in quotes. - API_HASH : This is to authenticate to your telegram account for downloading Telegram files. You can get this from https://my.telegram.org @@ -64,12 +64,14 @@ Note: You can limit maximum concurrent downloads by changing the value of MAX_CO ## Getting Google OAuth API credential file -- Visit the Google Cloud Console +- Visit the [Google Cloud Console](https://console.developers.google.com/apis/credentials) - Go to the OAuth Consent tab, fill it, and save. - Go to the Credentials tab and click Create Credentials -> OAuth Client ID - Choose Other and Create. - Use the download button to download your credentials. - Move that file to the root of mirror-bot, and rename it to credentials.json +- Visit [Google API page](https://console.developers.google.com/apis/library) +- Search for Drive and enable it if it is disabled - Finally, run the script to generate token file (token.pickle) for Google Drive: ``` pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib @@ -90,11 +92,11 @@ sudo docker build . -t mirror-bot sudo docker run mirror-bot ``` -## Using service accounts for uploading to avoid user rate limit - +# Using service accounts for uploading to avoid user rate limit +For Service Account to work, you must set USE_SERVICE_ACCOUNTS="True" in config file or environment variables Many thanks to [AutoRClone](https://github.com/xyou365/AutoRclone) for the scripts -### Generating service accounts -Step 1. Generate service accounts [What is service account](https://cloud.google.com/iam/docs/service-accounts) [How to use service account in rclone](https://rclone.org/drive/#service-account-support). +## Generating service accounts +Step 1. Generate service accounts [What is service account](https://cloud.google.com/iam/docs/service-accounts) --------------------------------- Let us create only the service accounts that we need. **Warning:** abuse of this feature is not the aim of autorclone and we do **NOT** recommend that you make a lot of projects, just one project and 100 sa allow you plenty of use, its also possible that overabuse might get your projects banned by google. @@ -110,4 +112,10 @@ A folder named accounts will be created which will contain keys for the service NOTE: If you have created SAs in past from this script, you can also just re download the keys by running: ``` python3 gen_sa_accounts.py --download-keys project_id -``` \ No newline at end of file +``` + +### Add all the service accounts to the Team Drive or folder +- Run: +``` +python3 add_to_team_drive.py -d SharedTeamDriveSrcID +```