deblan-mirror/borgwarehouse
deblan-mirror/borgwarehouse
1
0
Fork 0
mirror of https://github.com/Ravinou/borgwarehouse synced 2024-06-03 14:32:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix link to documentation

Browse source
This commit is contained in:
bsourisse 2022-12-13 16:13:08 +01:00
parent b2ae989d6a
commit 38824c2c6b
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -27,13 +27,13 @@ Today, if you want to have a large server on which you centralize backups of Bor
With BorgWarehouse, you have an interface that allows you to do all this simply and quickly : With BorgWarehouse, you have an interface that allows you to do all this simply and quickly :
- **add** repositories - **add** repositories
- **edit** existing repositories - **edit** existing repositories
- **delete** repositories - **delete** repositories
- be **alerted** if there are no recent backups - be **alerted** if there are no recent backups
- **monitor** the volume of data - **monitor** the volume of data
- **flexibly manage quotas** for each repository - **flexibly manage quotas** for each repository
- ... - ...
The whole system part is automatically managed by BorgWarehouse and **you don't have to touch your terminal anymore** while enjoying a visual feedback on the status of your repositories. The whole system part is automatically managed by BorgWarehouse and **you don't have to touch your terminal anymore** while enjoying a visual feedback on the status of your repositories.
@ -47,14 +47,14 @@ To run this project, you will need to add the following environment variables to
Variables to create (all required) : Variables to create (all required) :
- `NEXTAUTH_URL` : The url of your application as **https://borgwarehouse.com**. - `NEXTAUTH_URL` : The url of your application as **https://borgwarehouse.com**.
- `NEXTAUTH_SECRET` : A secret random key. - `NEXTAUTH_SECRET` : A secret random key.
- `CRONJOB_KEY` : A secret API key for cronjob. - `CRONJOB_KEY` : A secret API key for cronjob.
- `NEXT_PUBLIC_HOSTNAME` : FQDN as **borgwarehouse.com** - `NEXT_PUBLIC_HOSTNAME` : FQDN as **borgwarehouse.com**
- `NEXT_PUBLIC_SSH_SERVER_PORT` : SSH port of your server as **22**. - `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_RSA` : Your server SSH fingerprint for RSA.
- `NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ED25519` : Your server SSH fingerprint for ED25519. - `NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ED25519` : Your server SSH fingerprint for ED25519.
- `NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ECDSA` : Your server SSH fingerprint for ECDSA. - `NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ECDSA` : Your server SSH fingerprint for ECDSA.
Example for a valid `.env.local` file : Example for a valid `.env.local` file :
@ -69,12 +69,12 @@ NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ED25519=SHA256:tYQuzrZZMqaw0Bzvn/sMoDs1CVEitZ
NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ECDSA=SHA256:nTpxui1oEmH9konPau17qBVIzBQVOsD1BIbBFU5IL04 NEXT_PUBLIC_SSH_SERVER_FINGERPRINT_ECDSA=SHA256:nTpxui1oEmH9konPau17qBVIzBQVOsD1BIbBFU5IL04
``` ```
You can find more details about generating your secrets or retrieving your SSH fingerprint <a href="You can find more details about generating your secrets or retrieving your SSH fingerprint in the documentation.">in the documentation</a>. You can find more details about generating your secrets or retrieving your SSH fingerprint. You can find more details about generating your secrets or retrieving your SSH fingerprint <a href="https://borgwarehouse.com/docs/admin-manual/debian-installation/#configure-application-environment-variables">in the documentation</a>.
<!-- MARKDOWN LINKS & IMAGES --> <!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/ [next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB [next-url]: https://nextjs.org/
[React-url]: https://reactjs.org/ [react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[react-url]: https://reactjs.org/