Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
voronkovich committed Dec 25, 2021
1 parent 3c2106a commit bf166ad
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ jimbo --help

### Local config file (`.jimbo.conf`)

To customize site backup process you could create a special config file in your site's root folder:
To customize site backup process you can create a special config file in your site's root folder:

```sh
#
# The prefix 'xA4di35ie' added for security reasons,
# because site's root can be publicly available from the web.
# You can use any prefix you want.
# You can use any prefix you want or just omit it.
#

cat > xA4di35ie.jimbo.conf <<CONFIG
Expand All @@ -60,6 +60,24 @@ database_password: dbpass
CONFIG
```

### Main config file

If you don't want to store Jimbo's config in your site's root, you can create config file outside:

```sh
cat > /etc/jimbo/mysite.conf <<CONFIG
root: /var/www/mysite
plugin: default
include: index.html upload/*
CONFIG
```

Then you should specify path to config file instead of site's root:

```sh
jimbo backup /etc/jimbo/mysite.conf mysite.zip
```

## Uninstall

Local (`~/.local`):
Expand Down

0 comments on commit bf166ad

Please sign in to comment.