Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.17 KB

README.md

File metadata and controls

68 lines (49 loc) · 2.17 KB

pSync

GitHub release (with filter) GitHub all releases GitHub Repo stars

psync is a easy postgres backup, using Google Cloud Storage as vault.

It remembers which directories you use most frequently, so you can "jump" to them in just a few keystrokes.

Getting startedInstallationUsage


Getting started

Welcome to pSync, your trusted solution for scheduling PostgreSQL backups and sending them directly to Google Cloud Storage. We've designed pSync to be both powerful and user-friendly, ensuring that even users with minimal technical knowledge can get started in no time.

Installation

Installation is a easy process, just run the following shell script in your terminal: install.sh

install

After that, you will have systemd service created and ready to run. You can type: systemctl status psync.timer to check if it's running and systemctl start psync.timer to start it.

For single run, you need to add on your bash configuration file (e.g. ~/.bashrc) the following line (remember to fill with used path on installation):

PATH=$PATH:/opt/psync

Usage

To use psync as standalone run, you need to create a configuration file on your home directory, named psync.env with the following content:

export GOOGLE_APPLICATION_CREDENTIALS=</path/to/credential.json>

export PROJECT_ID=project_id>
export GCS_BUCKET_NAME=<gcs_bucket_name>

export PSQL_HOST=<postgres_host>
export PSQL_PORT=<postgres_port>
export PSQL_DBNAME=<postgres_dbname>
export PSQL_USER=<postgres_user>
export PSQL_PASSWORD=<postgres_password>

And finally, run the following commands:

$ source ./psync.env
$ psync