Skip to content
Snippets Groups Projects
Commit 2126fcce authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update docs

parent 0f2eacfa
No related branches found
No related tags found
1 merge request!135update docs
...@@ -149,3 +149,18 @@ env = '' ...@@ -149,3 +149,18 @@ env = ''
# ---------------------------------------------------------------------- # ----------------------------------------------------------------------
``` ```
## Database types
Since March 2024 the database backup uses profiles that can define a database locally or remote. Database services that can be connected via tcp port to a target host can be accessed remotely as well now. You can setup a backup host in your network that fetches the databases from the other hosts or a doxker container.
The following feature table is incomplete.
| Action \ database type | couchdb2 | mysql | postgres | sqlite | ldap |
| --- |--- |--- |--- |--- |--- |
| local database - dump | ✅ yes | ✅ yes | ✅ yes | ✅ yes | ✅ yes |
| local database - restore | ✅ yes | ✅ yes | ✅ yes | ✅ yes | ❌ no |
| local docker - dump | ✅ yes | ✅ yes | ✅ yes | ✅ yes | ❌ no |
| local docker - restore | ✅ yes | ✅ yes | ◻️ ??? | ✅ yes | ❌ no |
| remote database - dump | ✅ yes | ✅ yes | ✅ yes | ❌ no | ❌ no |
| remote database - restore | ✅ yes | ✅ yes | ◻️ ??? | ❌ no | ❌ no |
...@@ -10,7 +10,7 @@ Both of these steps can be started seperately (see next pages). ...@@ -10,7 +10,7 @@ Both of these steps can be started seperately (see next pages).
## Typical Usage ## Typical Usage
* on Linux: as a non root user use sudo `sudo ./backup.sh` * on Linux: as a non root user use sudo `sudo ./backup.sh`
* on MS Windows: start it as user `./backup.sh`. Or double click it in a file manager (e.g. Explorer). The first time it asks what program should be used to open *.sh files - select the bash.exe ornavigate to it. * on MS Windows: start it as user `./backup.sh`. Or double click it in a file manager (e.g. Explorer). The first time it asks what program should be used to open *.sh files - select the bash.exe or navigate to it.
## Help ## Help
...@@ -54,3 +54,7 @@ OPTIONS: ...@@ -54,3 +54,7 @@ OPTIONS:
-i, --inc force incrmenental backup -i, --inc force incrmenental backup
``` ```
## Flowchart
![Graph: backup process](./images/process_backup.png)
...@@ -121,8 +121,8 @@ This you can use to write a batch importer: ...@@ -121,8 +121,8 @@ This you can use to write a batch importer:
The syntax is The syntax is
`localdump.sh restore [type] [dumpfile]` `localdump.sh restore <type> <dumpfile>`
or or to import to another than the original database name
`localdump.sh restore [type] [dumpfile] [target-db]` `localdump.sh restore <type> <dumpfile> <target-db>`
docs/images/process_backup.png

314 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment