Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Visorask/sarotate

For rotating Google service accounts.
https://github.com/Visorask/sarotate

Last synced: 10 days ago
JSON representation

For rotating Google service accounts.

Host: GitHub
URL: https://github.com/Visorask/sarotate
Owner: Visorask
License: mit
Archived: true
Created: 2019-12-14T01:43:24.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2021-06-25T01:27:56.000Z (over 3 years ago)
Last Synced: 2024-08-01T12:28:11.239Z (3 months ago)
Language: Shell
Size: 133 KB
Stars: 40
Watchers: 2
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# SARotate

For rotating Google service accounts to bypass bans or any other myriad of reasons.

## Big Changes

So I just do not have time to update this anymore or provide help but the good news is there is a new and improved version which covers a lot of gaps that mine had and you should switch over to it, as it will be less buggy. This was my first real project into programming and while it was fun I do not feel it is worth spending more time on. This program will now be archived, but can still be utilized if you choose but any remaining bugs will do just that, remain.

To find this new version go here:

[SARotate](https://github.com/saltydk/SARotate) written by [saltydk](https://github.com/saltydk) and [toutas](https://github.com/toutas)

## Changelog 3.3

- [Added] Renamer script to rename `.json` files from something like [safire](https://github.com/88lex/safire).
- [Changed] Formatted code to smaller in size.
- [Changed] Moved loop for minsa into a function for more portability.

## Changelog 3.2

- [Added] Added flag `(-f)` to use the minimum service account set if you want to the rclone.conf to start from the minsa value.
- [Changed/Fixed] Adjusted the logic to be correct and not the same service account outside of the setting.

## Changelog 3.1

- [Added] Pushover support for apprise. If your apprise notification is not a part of the script yet let me know.
- [Changed] Added return code so the apprise doesn't go through every option, and only the 1 if off is returned.
- [Changed] Changed text a little bit for log rotation.
- [Fixed] Logr would return an issue with a character of the code. It is now fixed.

## Changelog 3.0

- [Added] New version.
- [Added] Uses a logger to easily identify issues.
- [Added] Script will check to see if the config you loaded exists, has information and if it matches the name you input.
- [Added] Much better logic for the handling of rotation.
- [Added] Now has much more error handling built in to prevent simple mistakes.
- [Added] Has a new `-h | help` option to let you know how to run the script. `./sarotate -h`
- [Added] Can utilize the same service account on all teamdrives if you wish within the config.
- [Added] Script will now check to see if your service accounts are within the minjs and maxjs set inside the config.
- [Added] Script will now "remember" the last used service account. It does this by reading the last set service account and uses logic to determine if it needs to change it or use it.
- [Added] Script will now rotate logs based on the size you have set. It will keep the last log file but with an appended number.
- [Changed] Overall improved and made the script easier to read and fixed issues it had before.
- [Changed] Changed apprise notifications. Now supports discord/slack by default with the config file.
- [Old] Installs the dependency needed (yyq) to utilize the script.
- [Old] Uses a .yml file for a more customized and easier configuration.
- [Old] Uses passed arguments through -c if you want to use more than one config file.
- [Old] Can define whichever rclone/lclone/fclone/gclone variant you want in config.
- [Old] Can utilize different rclone config files in config.
- [Old] Added header with version number and credits.
- [Old] Comments in the .yml file will be stripped before being run through the script.
- [Deleted] Old versions.

## What is it?

This script was created with the help of 88lex. This was written mainly for CloudBox users but can be utilized by anyone.

## Requirements

1. Any dependencies needed are taken care of by the script besides rclone.
2. rclone: `curl https://rclone.org/install.sh | sudo bash` | Minimum version of 1.51.

## Installation

1. `cd /opt`

2. `git clone https://github.com/Visorask/sarotate.git`

3. `sudo chown -R : sarotate` - Run `id` to find your user / group.

4. `cd /opt/sarotate && chmod +x sarotate renamer`

- `renamer` is a script for renaming your files from `000001.json` to `1.json`. This is required as that is how my script runs them.
- To run the script do: `./renamer -f /your/sa/path`
- This will rename all of your `.json` files into a readable format for my script.
- **WARNING:** `renamer` will NOT work with files named with alphabet characters. Example: `i-don't-like-numbers-01.json`

5. `cp config.yml.sample config.yml` if you want comments in your config or `cp config.yml.nocomments config.yml` if you do not want comments.

6. `nano config.yml` Edit the variables to match your settings. Save and close.

7. Once you have done all this then you will need to restart the mounts you want to rotate before running this script. A command might look like this: ```sudo systemctl restart .service```

Otherwise you might get an error like this:

```json
Failed to rc: Failed to read rc response: 404 Not Found: {
"error": "couldn't find method \"backend/command\"",
"input": {
"command": "set",
"fs": ":",
"opt": {
"service_account_file": ""
}
},
"path": "backend/command",
"status": 404
}
```

## Config

```yml
# General rclone variables.
rclone:
# Default rclone config. Change this if you have a non-standard rclone config location.
rclone_config: "$HOME/.config/rclone/rclone.conf"
# Match rclone rc mount user and pass. If you use --no-auth then leave as default.
rc_user: "user"
# Match rclone rc mount user and pass. If you use --no-auth then leave as default.
rc_pass: "pass"
# Default is localhost/127.0.0.1 but you can change this to match your IP for RC.
ip: 127.0.0.1
# Global variables
global:
# Minimum json file that you want to use.
minjs: 1
# Maximum json file that you want to use.
maxjs: 50
# Use 1 or 101. 101 will split API usage to separate projects, but needs many service accounts.
nextjs: 1
# Location of the directory with your service account files.
json_dir: "/your/path/here"
# Time the script will sleep for until running again.
sleeptime: 15m
# Set this if you would like to use the same service account for all remotes.
# |on|off(default)|
same_sa: off
# Log variables
log:
# Name that you want your log file to have.
logr_name: "sarotate"
# Directory that you want your log files stored in.
logr_dir: "/opt/sarotate/logs"
# At what size do you want your log to rotate. 1 is default. (MB)
logr_size: 1
# How detailed do you want your output to be from the script.
# |quiet(Supresses everything except errors and rclone output.)|verbose(default)(Everything is printed.)|
logr_detail: verbose
# rclone --log-level.
# |DEBUG|INFO|ERROR(recommended)|NOTICE(default for rclone)|
log_level: ERROR
apprise:
# Apprise notifications.
# |discord|slack|off(default)|
notif: off
# Insert discord webhook information.
# https://github.com/caronc/apprise/wiki/Notify_discord
disc_id: "{WebhookID}/{WebhookToken}"
# Insert webhook information.
# https://github.com/caronc/apprise/wiki/Notify_slack
slack_id: "{tokenA}/{tokenB}/{tokenC}"
# Insert webhook information.
# https://github.com/caronc/apprise/wiki/Notify_pushover
pushover_id: "{user_key}@{token}"
# When filling these out you need to make sure the order of remote/port goes together or else
# the script will read wrong input/output and give errors.
main:
remote:
- teamdrive1
- teamdrive2
- teamdrive3
- teamdrive4
port:
- 5572
- 5573
- 5574
- 5575
```

---

### Extra Information

For the script to work you must edit your mounts to have either `--rc-no-auth` or `--rc-user=` and `--rc-pass=`. You can add those into a live mount by doing:

- `sudo nano /etc/systemd/system/.service` (Fill in with your information.)
- `sudo systemctl daemon-reload`
- `sudo systemctl restart /etc/systemd/system/.service` (Fill in with your information.)
- `./sarotate -c .yml`

---

## If you would like to use crontab then follow the below steps

1. `crontab -e`
2. Add `@reboot sleep 1m && /opt/sarotate/sarotate`

---

## If you would like to use systemd then follow the below steps

1. `cd /opt/sarotate/system`
2. `nano sarotate.service`
3. Edit the user / group from `changethis` to your user / group. -Run `id` to find your user / group.
4. Exit and save the file.
5. `sudo cp /opt/sarotate/system/sarotate.service /etc/systemd/system/`
6. `sudo systemctl daemon-reload`
7. `sudo systemctl enable sarotate.service`
8. `sudo systemctl start sarotate.service`
9. If you would like to check that it is running working correctly run: `sudo service sarotate status`

---

## Troubleshooting

Will add more as people run into any issues.

## Donations

[PayPal](https://paypal.me/RRussell603)

BTC: 37iSj3YR1YP56fQi1Ue8fk1cYCuSmCugUB