Skip to content

Commit

Permalink
📝 Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
nicoverbruggen committed Dec 14, 2023
1 parent 0ec8cac commit 018ff4f
Showing 1 changed file with 15 additions and 23 deletions.
38 changes: 15 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,26 +42,32 @@ Notice that in this example file, the destination name is `nextcloud`, which mea

### Local

No extra environment variables are needed.
For Dropbox, set the access token first. You will need to authorize a separate app, which will normally write to its own app directory. Set the following keys in `.env`:

Create a job in the YAML file. The destination name should be `local`, but the path can be customized.
DROPBOX_ACCESS_TOKEN=

Create one or more jobs in the YAML file, with a destination name of `dropbox`. The path can be customized.

When done, run the following command:

```
./aegis backup:local <path-to-yaml>
./aegis backup:dropbox <path-to-yaml>
```

### Nextcloud

No extra environment variables are needed.
For Nextcloud, set the WebDAV credentials first. You may need to make a separate app password. Set the following keys in `.env`:

NEXTCLOUD_BASE_URI=
NEXTCLOUD_USERNAME=
NEXTCLOUD_PASSWORD=

Create a job in the YAML file. The destination name should be `local`, but the path can be customized.
Create one or more jobs in the YAML file, with a destination name of `nextcloud`. The path can be customized.

When done, run the following command:

```
./aegis backup:local <path-to-yaml>
./aegis backup:nextcloud <path-to-yaml>
```

## Getting started
Expand All @@ -75,27 +81,13 @@ When done, run the following command:
chmod +x ./aegis
touch .env

### NextCloud

For NextCloud, set the WebDAV credentials. You will need to make a separate app password:

NEXTCLOUD_BASE_URI=
NEXTCLOUD_USERNAME=
NEXTCLOUD_PASSWORD=

### Dropbox

For Dropbox, set the access token. You will need to authorize a separate app, which will normally write to its own app directory:

DROPBOX_ACCESS_TOKEN=

### Running backups
For more information about how to configure Aegis to work with Dropbox or Nextcloud, please see **Example usage** above.

Finally, create the backup configuration file (YAML). You can place this file wherever you want, but for this example we're storing it in `./jobs`. (You can find an example above.)
Finally, create the backup configuration file (YAML). You can place this file wherever you want, but for this example we're storing it in `./jobs`. You can find an example above.

touch ./jobs/backup.yaml

Set up the configuration as seen in the documentation, and then run the relevant command(s) (which ones to run depends on your jobs):
Set up the `.env` configuration file as seen in the documentation, and then run the relevant command(s). Which one(s) to run depends on your jobs.

./aegis backup:nextcloud ./jobs/backup.yaml
./aegis backup:dropbox ./jobs/backup.yaml
Expand Down

0 comments on commit 018ff4f

Please sign in to comment.