Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/skynet2/db-backup

Last synced: about 12 hours ago
JSON representation

Host: GitHub
URL: https://github.com/skynet2/db-backup
Owner: skynet2
License: mit
Created: 2022-09-17T11:14:24.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-08-11T15:28:46.000Z (3 months ago)
Last Synced: 2024-08-11T16:44:41.777Z (3 months ago)
Language: Go
Size: 105 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ## DB-BACKUP Tool

![build workflow](https://github.com/skynet2/db-backup/actions/workflows/release.yaml/badge.svg?branch=master)

[![go-report](https://goreportcard.com/badge/github.com/skynet2/db-backup)](https://goreportcard.com/report/github.com/skynet2/db-backup)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/skynet2/db-backup)](https://pkg.go.dev/github.com/skynet2/db-backup?tab=doc)

### Simple database backup tool with support for remote storage.

## Supported databases (providers)

- [x] postgres (requires pg_dump)

- [ ] mssql

## Supported storages (providers)

- [x] s3

- [x] s3 compatible (provider = s3)

- [ ] ftp

## Supported notification channels (providers)

- [x] discord

- [x] telegram

- [ ] slack

## Configuration example

```yml

exclude_dbs:

  - stats

db:

  provider: postgres

  dump_dir: "/var/backup/"

  postgres:

    host: "127.0.0.1"

    port: 5432

    user: postgres

    password: qwerty

    db_default_name: postgres

    tls_enabled: false

storage:

  provider: s3

  dir_template: "{{.Host}}/{{.DbName}}"

  max_files: 3

  s3:

    region: "nl-ams"

    endpoint: "https://s3.nl-ams.scw.cloud"

    bucket: "myawesomebacket"

    access_key: "access_key"

    secret_key: "secret_key"

    disable_ssl: true

    force_path_style: false

notifications:

  success:

    channels:

      - type: telegram

        token: "bot_token"

        chat: "chat_id"

      - type: discord

        webhook: "https://my-discord-webhook-url"

```

### Configuration fields

* include_dbs - include only specified databases in backup job

* exclude_dbs - exclude specific databases from backup job

* db - database connection settings

  * provider - database provider (ex. postgres)

  * dump_dir - temporary directory for backup process

  * postgres - postgres provider configuration

    * host - server ip\hostname

    * port - port

    * user - user

    * password - password

    * db_default_name - default database name (postgres)

    * tls_enabled - tls configuration (true\false)

    * compression_level = database compression level (pg_dump configuration), 5 by default

* storage

  * provider - storage provider (ex. s3)

  * dir_template - golang template for remote directory. supported values : {{.Host}} and {{.DbName}}

  * max_files - max remote backups for specific database. For example max_files = 5 and if we already have 5 files for that database at remote storage, the oldest file will be removed

  * s3 - s3 provider configuration

    * region - region

    * endpoint - endpoint (s3 compatible storages)

    * bucket - bucket

    * access_key - access_key

    * secret_key - secret_key

    * disable_ssl - disable_ssl (true\false)

    * force_path_style - force_path_style (true\false)

* Notifications

  * success - will be called on success 

    * channels - array of notification channels

      * type - channel type (ex. discord or telegram)

      * token - required for telegram (bot token)

      * chat - chat_id (telegram)

      * webhook - webhook url (discord)

    * template - custom go template

  * fail - exactly same as success, but will be executed on fail or error. if fail - empty, success will be used