Browse Source

Add basic documentation

master
Lukas Bestle 1 year ago
parent
commit
cdd6299cfa
Signed by: lukas GPG Key ID: 692037D104550FC9
  1. 21
      LICENSE.md
  2. 18
      README.md
  3. 17
      vars/vault.example.yml

21
LICENSE.md

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 Lukas Bestle <project-ansible-playbooks@lukasbestle.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

18
README.md

@ -0,0 +1,18 @@
# Ansible Playbook for Uberspace
## Installation
- Ensure that you have a recent Ansible version installed (tested with 2.9.10+)
- Install module dependencies using: `ansible-galaxy install -r requirements.yml`
## Commands
```
./run # Execute the full Playbook
./run gitea-update # Only update Gitea on Git Uberspaces
./run radicale-update # Only update Radicale on DAV Uberspaces
```
## License
[The MIT License](https://git.codesignd.com/ansible-playbooks/kodos/src/branch/master/LICENSE.md)

17
vars/vault.example.yml

@ -0,0 +1,17 @@
---
# dav: Users with hashed passwords
dav_users:
username: $2y$05$...
# git: Secrets for Gitea
git_secret_key: ...
git_internal_token: ...
git_jwt_secret: ...
# mail: User password
mail_passwords:
cddmail1: ...
cddmail2: ...
# web: Webhook secret for deployments
projectr_deploy_secret: ...
Loading…
Cancel
Save