johannes/kopia-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
kopia-backup/README.md
Johannes Randerath ddbced89cf Add explicit licensing (under GPL v3.0
2024-06-13 23:14:37 +02:00

1.1 KiB
Raw Permalink Blame History

Automatic backup script to use with Kopia and S3 compatible object storage

Dependencies

  • S3 compatible storage optional
  • bash shell
  • kopia (CLI)
  • an internet connection

Installation

  1. Create a file called kopia_environment
  2. Set the following environment variables inside the new file:
    • BUCKET_NAME: Name of the bucket to use in your S3 compatible storage
    • ACCESS_KEY: Access key for your object storage
    • SECRET_ACCESS_KEY: Secret key for the object storage
    • ENDPOINT: API endpoint for the object storage
    • DIRS: Directories to take snapshots of, space separated
    • LOGPATH: Directory to store log files in
    • REPO_PASSWORD: Password to for the kopia repository
  3. Create the kopia repository: 
    source kopia_environment &&
kopia repository create --access-key=$ACCESS_KEY --secret-access-key=$SECRET_ACCESS_KEY --ENDPOINT=$ENDPOINT -p $REPO_PASSWORD
  4. Setup cronjob (optional)

License

The project is licensed under the GPL v3.0 (or later). Please see LICENSE.md or fsf.org