Skip to content

Commit 608953f

Browse files
committed
GUIDE: install, backup, upgrade
1 parent 01d128b commit 608953f

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

GUIDE.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Madek Hosting Guide
2+
13
## quickstart
24

35
1. ["Fork" this repository on github](https://github.com/Madek/madek-instance/fork)
@@ -21,6 +23,30 @@
2123
- global config in file `group_vars/madek.yml`
2224
- per-host config in file `host_vars/madek.example.com.yml`, rename it to match the hostname
2325

24-
1. install `ansible-playbook -i hosts Madek/deploy/play_setup-and-deploy.yml`
26+
1. install with ansible
27+
```sh
28+
ansible-playbook -i hosts Madek/deploy/play_setup-and-deploy.yml
29+
```
30+
31+
1. setup initial configuration & admin account:
32+
```sh
33+
ansible-playbook -i hosts Madek/deploy/play_first-time-setup.yml
34+
```
35+
36+
## backup
37+
38+
A `master_secret` was created during the installation and put in a text file
39+
in your repository.
40+
By default it is git-ignored, so it won't be accidentially pushed to a public
41+
host (like GitHub).
42+
You should either back up your local repository to a secure place;
43+
or use [`git-crypt`](https://www.agwa.name/projects/git-crypt/) to add the
44+
secret to the repository in encrypted form (*recommended*).
45+
46+
## upgrade
47+
48+
1. update Madek submodule reference to latest release
49+
- either by accepting a Pull Request (when enabled)
50+
- or manually: `cd Madek && git fetch && git reset --hard origin/release && cd -`
2551

26-
1. (setup admin account)
52+
1. run the setup playbook again: `ansible-playbook -i hosts Madek/deploy/play_setup-and-deploy.yml`

0 commit comments

Comments
 (0)