Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jckleiner/notion-backup
Automatic Notion workspace backup to Google Drive, Dropbox, pCloud, Nextcloud or to your local machine.
https://github.com/jckleiner/notion-backup
backup notion notion-automation notion-backup notion-export
Last synced: 3 months ago
JSON representation
Automatic Notion workspace backup to Google Drive, Dropbox, pCloud, Nextcloud or to your local machine.
- Host: GitHub
- URL: https://github.com/jckleiner/notion-backup
- Owner: jckleiner
- Created: 2020-12-31T19:30:17.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-24T07:42:20.000Z (11 months ago)
- Last Synced: 2024-04-10T07:34:01.498Z (7 months ago)
- Topics: backup, notion, notion-automation, notion-backup, notion-export
- Language: Java
- Homepage:
- Size: 191 KB
- Stars: 69
- Watchers: 3
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# notion-backup
> ⚠️ Notion changed their API around 12.2022 which broke the automatic login requests made by this tool to extract the
> `token_v2`.
>
> To solve this new limitation, you need to copy the value of the `token_v2` cookie manually (see [How do I find
> all these values?](./documentation/setup.md) for more info).
Automatically backup your Notion workspace to Google Drive, Dropbox, pCloud, Nextcloud or to your local machine.
### Set Credentials
Create a `.env` file with the following properties ([How do I find all these values?](./documentation/setup.md)):
# Make sure not to use any quotes around these environment variables
# Notion (Required)
NOTION_SPACE_ID=
NOTION_TOKEN_V2=
# Options: markdown, html (default is markdown)
NOTION_EXPORT_TYPE=markdown
# Create folders for nested pages? Options: true, false (default is false)
NOTION_FLATTEN_EXPORT_FILETREE=false
# Should export comments? Options: true, false (default is true)
NOTION_EXPORT_COMMENTS=true
# Google Drive (Optional)
GOOGLE_DRIVE_ROOT_FOLDER_ID=
GOOGLE_DRIVE_SERVICE_ACCOUNT=
# Provide either secret json or the path to the secret file
GOOGLE_DRIVE_SERVICE_ACCOUNT_SECRET_JSON=
GOOGLE_DRIVE_SERVICE_ACCOUNT_SECRET_FILE_PATH=
# Dropbox (Optional)
DROPBOX_ACCESS_TOKEN=
DROPBOX_APP_KEY=
DROPBOX_APP_SECRET=
DROPBOX_REFRESH_TOKEN=
# Nextcloud (Optional)
NEXTCLOUD_EMAIL=
NEXTCLOUD_PASSWORD=
NEXTCLOUD_WEBDAV_URL=
# pCloud (Optional)
PCLOUD_ACCESS_TOKEN=
PCLOUD_API_HOST=
PCLOUD_FOLDER_ID=
# if you don't use the Docker image and want to download the backup to a different folder
# DOWNLOADS_DIRECTORY_PATH=
### Backup to Cloud With Docker
Once you created your `.env` file, you can run the following command to start your backup:
```bash
docker run \
--rm=true \
--env-file=.env \
ghcr.io/jckleiner/notion-backup
```
The downloaded Notion export file will be saved to the `/downloads` folder **within the Docker container** and the container
will be removed after the backup is done (because of the `--rm=true` flag).
If you want automatic backups in regular intervals, you could either set up a cronjob on your local machine or
[fork this repo](#fork-github-actions) and let GitHub Actions do the job.
### Local Backup With Docker
If you want to keep the downloaded files locally, you could mount the `/downloads` folder from the container somewhere
on your machine:
```bash
docker run \
--rm=true \
--env-file=.env \
-v :/downloads \
ghcr.io/jckleiner/notion-backup
```
If you want automatic backups in regular intervals, you could either set up a cronjob on your local machine or
[fork this repo](#fork-github-actions) and let GitHub Actions do the job.
### Fork (GitHub Actions)
Another way to do automated backups is using GitHub Actions. You can simply:
1. Fork this repository.
2. Create repository secrets: Go to `notion-backup (your forked repo) > Settings > Secrets > Actions` and create all
the [necessary environment variables](#set-credentials).
3. Go to `notion-backup (your forked repo) > Actions` to see the workflows and make sure the
`notion-backup-build-run` workflow is enabled. This is the workflow which will periodically build and run the
application.
4. You can adjust when the action will be triggered by editing the `schedule > cron` property in your
[notion-backup/.github/workflows/build-run.yml](.github/workflows/build-run.yml)
workflow file (to convert time values into cron expressions: [crontab.guru](https://crontab.guru/)).
That's it. GitHub Actions will now run your workflow regularly at your defined time interval.
## Troubleshooting
### Dropbox
If you get the exception: `com.dropbox.core.BadResponseException: Bad JSON: expected object value.`, then try to
re-generate your Dropbox access token and run the application again.
### pCloud
If you get the exception: `com.pcloud.sdk.ApiError: 2094 - Invalid 'access_token' provided.`,
please also make sure that the `PCLOUD_API_HOST` environment variable is correct. There are currently two API hosts:
one for Europe (`eapi.pcloud.com`) and one for the rest (`api.pcloud.com`).
If you still get the error, please try and regenerate the access token as described in the [pCloud section](./documentation/setup.md#pcloud)
of the documentation.