Improve docs
This commit is contained in:
23
README.md
23
README.md
@@ -7,6 +7,7 @@
|
||||
|
||||
## Требования
|
||||
|
||||
- [uv](https://docs.astral.sh/uv/)
|
||||
- [ansible](https://docs.ansible.com/ansible/latest/getting_started/index.html)
|
||||
- [task](https://taskfile.dev/)
|
||||
- [yq](https://github.com/mikefarah/yq)
|
||||
@@ -14,17 +15,21 @@
|
||||
## Установка
|
||||
|
||||
```bash
|
||||
$ cp ansible-vault-password-file.dist ansible-vault-password-file
|
||||
$ ansible-galaxy install --role-file requirements.yml
|
||||
uv sync
|
||||
|
||||
cp ansible-vault-password-file.dist ansible-vault-password-file
|
||||
|
||||
uv run ansible-galaxy install --role-file requirements.yml
|
||||
```
|
||||
|
||||
## Структура
|
||||
|
||||
- Для каждого приложения создается свой пользователь (опционально).
|
||||
- Для каждого приложения создается свой пользователь.
|
||||
- Для доступа используется ssh-ключ.
|
||||
- Безопасность осуществляется с помощью `ufw` и `fail2ban`.
|
||||
- Докер используется для запуска и изоляции приложений. Для загрузки образов настраивается Yandex Docker Registry.
|
||||
- Выход во внешнюю сеть через proxy server [Caddy](https://caddyserver.com/).
|
||||
- Чувствительные данные в `vars/vars.yaml` зашифрованы с помощью Ansible Vault.
|
||||
- Чувствительные данные в [secrets.yml](vars/secrets.yml) зашифрованы с помощью Ansible Vault.
|
||||
- Для мониторинга за сервером устанавливается [netdata](https://github.com/netdata/netdata).
|
||||
|
||||
## Настройка DNS
|
||||
@@ -33,8 +38,14 @@ $ ansible-galaxy install --role-file requirements.yml
|
||||
|
||||
## Деплой приложений
|
||||
|
||||
Деплой всех приложений через ansible:
|
||||
Деплой приложения через ansible:
|
||||
|
||||
```bash
|
||||
ansible-playbook -i production.yml --diff playbook-gitea.yml
|
||||
uv run ansible-playbook ansible-playbook -i production.yml --diff playbook-gitea.yml
|
||||
```
|
||||
|
||||
## Удаление приложения <name>
|
||||
|
||||
```bash
|
||||
uv run ansible-playbook -i production.yml --diff playbook-remove-user-and-app.yml --extra-vars user_name=<name>
|
||||
```
|
||||
|
||||
@@ -31,8 +31,8 @@
|
||||
- name: 'Configure wanderer'
|
||||
ansible.builtin.import_playbook: playbook-wanderer.yml
|
||||
|
||||
- name: 'Configure kavita'
|
||||
ansible.builtin.import_playbook: playbook-kavita.yml
|
||||
- name: 'Configure calibre'
|
||||
ansible.builtin.import_playbook: playbook-calibre.yml
|
||||
|
||||
#
|
||||
|
||||
|
||||
@@ -25,6 +25,11 @@
|
||||
path: "/var/www/{{ user_name }}"
|
||||
state: absent
|
||||
|
||||
- name: "Remove application dir"
|
||||
ansible.builtin.file:
|
||||
path: "/mnt/applications/{{ user_name }}"
|
||||
state: absent
|
||||
|
||||
- name: "Remove home dir"
|
||||
ansible.builtin.file:
|
||||
path: "/home/{{ user_name }}"
|
||||
|
||||
Reference in New Issue
Block a user