https://github.com/richbl/gogs-remote-backup
Remotely back up a Gogs (Go Git Service) database and selected files and folders
https://github.com/richbl/gogs-remote-backup
backup bash bash-script database gitea go gogs golang postgresql remote shell shell-script
Last synced: 4 months ago
JSON representation
Remotely back up a Gogs (Go Git Service) database and selected files and folders
- Host: GitHub
- URL: https://github.com/richbl/gogs-remote-backup
- Owner: richbl
- License: mit
- Created: 2016-12-12T01:51:56.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T00:16:12.000Z (almost 3 years ago)
- Last Synced: 2025-07-31T01:56:05.562Z (6 months ago)
- Topics: backup, bash, bash-script, database, gitea, go, gogs, golang, postgresql, remote, shell, shell-script
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gogs-Remote-Backup
**Gogs-Remote-Backup** (`run_gogs_remote_backup.sh`) is a [bash](https://en.wikipedia.org/wiki/Bash_%28Unix_shell%29) script to remotely back up key files/folders used in a [Gogs](https://gogs.io/) installation using the secure remote copy ([scp](http://man7.org/linux/man-pages/man1/scp.1.html)) command. Specifically, **Gogs-Remote-Backup** backs up the following:
- The [PostgreSQL](https://www.postgresql.org/) database used by [Gogs](https://gogs.io/)
- The [Gogs](https://gogs.io/) custom configuration file called `app.ini`. This file is important, as it contains all configuration details regarding the current [Gogs](https://gogs.io/) install
- The [Gogs](https://gogs.io/) [Git](https://git-scm.com/) repositories located in the `gogs-repositories` folder
> **Note:** [Gogs](https://gogs.io/) can be installed using other database options: this script currently only supports [PostgreSQL](https://www.postgresql.org/).
Importantly, `run_gogs_remote_backup.sh` is intended to be used for making unattended script calls (*e.g.*, running cron jobs) into a set of related [Git](https://git-scm.com/) projects configured as [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), making it easy to use this project as a front-end while the supporting submodule projects get updated independently. The two submodule projects are:
- [**Postgresql-Db-Dump**](https://github.com/richbl/postgresql-db-dump), used to remotely dump a [PostgreSQL](https://www.postgresql.org/) database
- [**Remote-Folder-Copy**](https://github.com/richbl/remote-folder-copy), used to remotely copy a folder
## Requirements
- An operational [bash](https://en.wikipedia.org/wiki/Bash_%28Unix_shell%29) environment (bash 4.3.46 used during development)
- The requirements of each of the two submodule projects used in this project. Note that each submodule project will alert the user to missing dependencies at runtime
While this package was written and tested under Linux (Ubuntu 16.10), there should be no reason why this won't work under other Unix-like operating systems.
## Basic Usage
Be sure to review and edit the contents of the **Gogs-Remote-Backup** script (`run_gogs_remote_backup.sh`) to customize script parameters and folder options.
> **Note:** **Gogs-Remote-Backup** really only serves as a wrapper for [**Postgresql-Db-Dump**](https://github.com/richbl/postgresql-db-dump) and [**Remote-Folder-Copy**](https://github.com/richbl/remote-folder-copy), so a good understanding of the parameters passed into these scripts is important.
Because **Gogs-Remote-Backup** is intended to run unattended, the only usage is to call the script directly, with no additional parameters passed on the command line.
$ ./run_gogs_remote_backup.sh
## IMPORTANT: This Project Uses Git Submodules 
This project uses [Git submodule projects](https://git-scm.com/book/en/v2/Git-Tools-Submodules) (located in the `postgresql-db-dump` and the `remote-folder-copy` folders) to keep this project up-to-date without manual intervention.
**Be sure to clone this project with the `--recursive` switch** (`git clone --recursive https://github.com/richbl/this_project`) so any submodule project(s) will be automatically cloned as well. If you clone into this project without this switch, you'll likely see empty submodule project folders (depending on your version of Git).