diff options
| author | alex <alex@pdp7.net> | 2025-10-11 21:27:30 +0200 |
|---|---|---|
| committer | alex <alex@pdp7.net> | 2025-10-11 21:27:30 +0200 |
| commit | 4bbf78f4ea4a7ff8afa99779cd1676cb73c97b68 (patch) | |
| tree | dab8052a3c7d17c2d26455744dced5a2b76cd2c2 /infrastructure/roles | |
| parent | dfd9b591d96b09b37474ab64ad04cb26316e73bf (diff) | |
Flesh out documentation
Diffstat (limited to 'infrastructure/roles')
| -rw-r--r-- | infrastructure/roles/git/README.md | 14 | ||||
| -rw-r--r-- | infrastructure/roles/users/README.md | 7 | ||||
| -rw-r--r-- | infrastructure/roles/vaultwarden/README.md | 5 |
3 files changed, 16 insertions, 10 deletions
diff --git a/infrastructure/roles/git/README.md b/infrastructure/roles/git/README.md index f21bfef..90a558d 100644 --- a/infrastructure/roles/git/README.md +++ b/infrastructure/roles/git/README.md @@ -5,29 +5,27 @@ On the server: ``` -git init --bare $REPO +git init --bare $REPOSITORY_PATH ``` ## Push an existing repository ``` -git remote add $REMOTE_NAME $SERVER:$REPO -git push $REMOTE_NAME main +git remote add $REMOTE $SERVER_HOSTNAME:$REPOSITORY_PATH +git push $REMOTE main ``` ## Exposing via gitweb ``` -sudo ln -s $ABSOLUTE_PATH_TO_REPO /var/lib/git/$NAME.git +sudo ln -s $REPOSITORY_PATH /var/lib/git/$NAME.git ``` -You can use `~/foo` as the `ABSOLUTE_PATH_TO_REPO` to expose a repository in your home directory. - ## Exposing via https ``` -mv $ABSOLUTE_PATH_TO_REPO/hooks/post-update.sample $ABSOLUTE_PATH_TO_REPO/hooks/post-update -ln -s $ABSOLUTE_PATH_TO_REPO ~/public_html/$REPO.git +mv $REPOSITORY_PATH/hooks/post-update.sample $REPOSITORY_PATH/hooks/post-update +ln -s $REPOSITORY_PATH ~/public_html/$REPO.git ``` Ensure that you push once to the repo, or run `git update-server-info` in the repository. diff --git a/infrastructure/roles/users/README.md b/infrastructure/roles/users/README.md index 3741ff1..a1ad1ea 100644 --- a/infrastructure/roles/users/README.md +++ b/infrastructure/roles/users/README.md @@ -1,11 +1,14 @@ # Users -## Initial set up +## Creating users + +This role creates users described in the [production](../../production.yaml) inventory. +Change this file to create new users. This role creates users in the `sudo` group. `sudo` requires a password. -To set your password, run `su -c "passwd $(whoami)"`. +Once you can ssh to your user, set your password with `su -c "passwd $(whoami)"`. From then on, use `sudo` for privileged actions. Remember to only modify the system using Ansible. diff --git a/infrastructure/roles/vaultwarden/README.md b/infrastructure/roles/vaultwarden/README.md index e899348..ad689cc 100644 --- a/infrastructure/roles/vaultwarden/README.md +++ b/infrastructure/roles/vaultwarden/README.md @@ -1,5 +1,10 @@ # Vaultwarden +## Registering to Vaultwarden + +Registration is limited to the `@localhost` domain so that only local users can register. +Registration requires email validation. + Visit `/vaultwarden`, select "create account", then use `$USER@localhost` as your email address. 1. Run `mutt`. |