deblan-mirror/borgwarehouse
deblan-mirror/borgwarehouse
1
0
Fork 0
mirror of https://github.com/Ravinou/borgwarehouse synced 2024-06-02 05:52:13 +02:00
Code Issues Packages Projects Releases Wiki Activity
borgwarehouse/README.md
Ravinou 290920b06e
Improve README
2022-12-01 13:49:08 +01:00

2.4 KiB
Raw Blame History

Next React

BorgWarehouse

A fast and modern WebUI for a BorgBackup's central repository server.
Explore the docs »

Get started

You can find the documentation here : https://borgwarehouse.com/

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env.local file.

Variables to create (all required) :

  • NEXTAUTH_URL : The url of your application as https://borgwarehouse.com.
  • NEXTAUTH_SECRET : A secret random key.
  • CRONJOB_KEY : A secret API key for cronjob.
  • NEXT_PUBLIC_HOSTNAME : FQDN as borgwarehouse.com
  • NEXT_PUBLIC_SSH_SERVER_PORT : SSH port of your server as 22.
  • NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_RSA : Your server SSH fingerprint for RSA.
  • NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ED25519 : Your server SSH fingerprint for ED25519.
  • NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ECDSA : Your server SSH fingerprint for ECDSA.

Example for a valid .env.local file :

NEXTAUTH_URL=https://yourbwdomain.com
NEXTAUTH_SECRET=YOURFIRSTSECRET
CRONJOB_KEY=YOURSECONDSECRET
NEXT_PUBLIC_HOSTNAME=yourbwdomain.com
NEXT_PUBLIC_SSH_SERVER_PORT=22
NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_RSA=SHA256:36mfYNRrm1aconVt6cBpi8LhAoPP4kB8QsVW4n8eGHQ
NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ED25519=SHA256:tYQuzrZZMqaw0Bzvn/sMoDs1CVEitZ9IrRyUg02yTPA
NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ECDSA=SHA256:nTpxui1oEmH9konPau17qBVIzBQVOsD1BIbBFU5IL04

You can find more details about generating your secrets or retrieving your SSH fingerprint in the documentation.