Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d0whc3r/node-gdrive
Google drive api for node made easy with typescript
https://github.com/d0whc3r/node-gdrive
backup compress copy drive gdrive google google-drive googleapi node upload
Last synced: 2 months ago
JSON representation
Google drive api for node made easy with typescript
- Host: GitHub
- URL: https://github.com/d0whc3r/node-gdrive
- Owner: d0whc3r
- Created: 2019-03-04T07:15:44.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T23:12:10.000Z (3 months ago)
- Last Synced: 2024-10-20T10:26:28.165Z (3 months ago)
- Topics: backup, compress, copy, drive, gdrive, google, google-drive, googleapi, node, upload
- Language: TypeScript
- Homepage: https://hub.docker.com/r/d0whc3r/gdrive
- Size: 1.5 MB
- Stars: 6
- Watchers: 5
- Forks: 3
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# :floppy_disk: Node gdrive
Utility to manipulate google drive using nodejs. It could upload content to google drive and it could be used as backup service.
# :eyes: Project status
[](https://github.com/d0whc3r/node-gdrive)
[](https://codecov.io/gh/d0whc3r/node-gdrive)
[](https://www.codacy.com/app/d0whc3r/node-gdrive?utm_source=github.com&utm_medium=referral&utm_content=d0whc3r/node-gdrive&utm_campaign=Badge_Grade)
[](https://sonarcloud.io/dashboard?id=d0whc3r_node-gdrive)
[](https://sonarcloud.io/dashboard?id=d0whc3r_node-gdrive)
[](https://sonarcloud.io/dashboard?id=d0whc3r_node-gdrive)
[](https://sonarcloud.io/dashboard?id=d0whc3r_node-gdrive)
[](https://sonarcloud.io/dashboard?id=d0whc3r_node-gdrive)
[](https://www.npmjs.com/package/@d0whc3r/node-gdrive)
[](https://hub.docker.com/r/d0whc3r/gdrive)
[](https://hub.docker.com/r/d0whc3r/gdrive)
[](https://hub.docker.com/r/d0whc3r/gdrive)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fd0whc3r%2Fnode-gdrive?ref=badge_shield)
## :key: Create credentials and token files
To get `credentials.json` file you need to visit:
- [https://developers.google.com/drive/api/v3/quickstart/nodejs](https://developers.google.com/drive/api/v3/quickstart/nodejs)
Then click `ENABLE THE DRIVE API` and click `DOWNLOAD CLIENT CONFIGURATION`
This will download **credentials.json** file, you can save it in *secrets* folder in the project.
Now you need to generate **token.json** file, to do this you need to execute any command to access your google-drive, for example:
### :boat: Using docker
Then you could execute a simple command to generate token.json:
> Be careful to copy `credentials.json` into `$PWD/secrets` path
```bash
docker run --rm -it -v $PWD/secrets:/app/secrets/ d0whc3r/gdrive -l
```
### :pencil: Using downloaded project
> First you need to download project from github using:
```bash
git clone https://github.com/d0whc3r/node-gdrive.git
cd node-gdrive
yarn install
```
Then you could execute a simple command to generate token.json:
```bash
yarn cli -l
```
### :beginner: Next step
Using docker or project files the `-l` command is for listing existing files in google-drive
If *credentials.json* is present but *token.json* is missing this last file will be generated showing an url into terminal output, you need to enter that url and validate all needed permisions, then a token will be shown in your web browser, this token need to be pasted in terminal.
By default this software check for credentials (and token) file in folder `secrets` but it could be changed using environment variables:
- **CREDENTIALS_FILE**: File with credentials (credentials.json)
- **TOKEN_FILE**: File with token, generated using credentials (token.json)
## :boat: Docker usage
You could use cli app in docker
### :rowboat: Build docker image
```bash
docker build -t gdrive .
```
### :checkered_flag: Run cli commands inside docker
```bash
docker run --rm gdrive --help
```
To make docker image work properly you need to indicate where credentials and token are located
```bash
docker run --rm -v $PWD/secrets:/app/secrets:ro gdrive -l
```
## :checkered_flag: Cli help output
Using docker image from [hub.docker.com](https://hub.docker.com/r/d0whc3r/gdrive)
```bash
docker run --rm d0whc3r/gdrive --help
```
```
Help for gdrive
Usage of npm gdrive in command line.
Options
-l, --list List all files and folders
-b, --backup file* Backup files
-z, --zip zipname.zip Zip backup files
-r, --replace Replace files if already exists when backup upload
-c, --create Create destination upload folder
-f, --folder foldername Folder name to upload file/s
-d, --delete foldername=duration OR duration Clean files older than duration in foldername
-m, --mysql Mysql backup using environment variables to connect mysql server
($MYSQL_USER, $MYSQL_PASSWORD, $MYSQL_DATABASE, $MYSQL_HOST, $MYSQL_PORT)
-h, --help Print this usage guide.
Examples
1. List files. $ gdrive -l
2. Backup multiple files to "backupFolder" folder. $ gdrive -b src/index.ts -b images/logo.png -f backupFolder
3. Backup files using wildcard to "backup" folder. $ gdrive -b src/* -b images/* -f backup
4. Backup files using wildcard and zip into "zipped" folder folder will be $ gdrive -b src/* -b images/* -z -f zipped -c
created if it doesn't exists.
5. Backup files using wildcard and zip using "allfiles.zip" as filename into $ gdrive -b src/* -b images/* -z allfiles.zip -f zipped -c -r
"zipped" folder folder will be created if it doesn't exists and zipfile will be
replaced if it exists
6. Delete files in "uploads" folder older than 2days and files in "monthly" $ gdrive -d uploads=2d -d monthly=1M
folder older than 1month
7. Delete files in "uploads" folder older than 1minute $ gdrive -f uploads -d 1m
8. Generate mysql dump file zip it and upload to "mysql-backup" folder $ gdrive -f mysql-backup -m -z
```
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fd0whc3r%2Fnode-gdrive?ref=badge_large)