ansible/ansible_role_etebase
1
0
Fork 0
mirror of https://github.com/roles-ansible/ansible_role_etebase.git synced 2024-08-16 10:19:52 +02:00
Code Releases Activity

Merge pull request #4 from roles-ansible/docs

Browse source 
improve docs
This commit is contained in:
L3D 2022-11-15 02:08:01 +01:00 committed by GitHub
commit 6bad70263a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -4,10 +4,6 @@
=================================================== ===================================================
Ansible role to Setup and Confugure Etebase - The Backend from EteSync 2.0 -> https://github.com/etesync/server Ansible role to Setup and Confugure Etebase - The Backend from EteSync 2.0 -> https://github.com/etesync/server
```
WORK IN PROGRESS!!!
```
Details Details
--------- ---------
This Ansible role installs and configures etebase, the backend of etesync. A piece of software to securely sync your contacts, calendars, tasks and notes! This Ansible role installs and configures etebase, the backend of etesync. A piece of software to securely sync your contacts, calendars, tasks and notes!
@ -18,20 +14,20 @@ What this Ansible role does not create are users in Etebase. And the configurati
----------- -----------
| variable | value | description | | variable | value | description |
| -------- | ----- | ----------- | | -------- | ----- | ----------- |
| etebase__user | 'etebase' | The Unix User for etebase | | etebase__user | ``etebase`` | The Unix User for etebase |
| etebase__group | 'etebase' | The Unix Group for etebase | | etebase__group | ``etebase`` | The Unix Group for etebase |
| etebase__user_home | '/var/lib/etebase' | Etebase User Home | | etebase__user_home | ``/var/lib/etebase`` | Etebase User Home |
| etebase__shell | '/bin/false' | Default Shell of Etebase User | | etebase__shell | ``/bin/false`` | Default Shell of Etebase User |
| etebase__venv | "{{ etebase__user_home }}/venv" | Etebase venv path | | etebase__venv | ``{{ etebase__user_home }}/venv`` | Etebase venv path |
| etebase__socket | '/tmp/etebase_server.sock' | Etebase Socket path *(only if ``etebase__systemd_setup`` is set to ``true``)* | | etebase__socket | ``/tmp/etebase_server.sock`` | Etebase Socket path *(only if ``etebase__systemd_setup`` is set to ``true``)* |
| etebase__package_state | 'present' | Set to ``latest`` to upgrade all etebase required system and pip packages to the latest version | | etebase__package_state | ``present`` | Set to ``latest`` to upgrade all etebase required system and pip packages to the latest version |
| etebase__version | 'latest' | Etebase Release Tag | | etebase__version | ``latest`` | Etebase Release Tag |
| etebase__secrets_dir | "{{ etebase__user_home }}/secrets" | Path to store etebase secrets | | etebase__secrets_dir | ``{{ etebase__user_home }}/secrets`` | Path to store etebase secrets |
| etebase__collectstatic | true | Generate static files for etebase | | etebase__collectstatic | ``true`` | Generate static files for etebase |
| etebase__restart_webserver | false | Set to ``true`` to restart the webserver on config change *(etebase__systemd_setup needed)*| | etebase__restart_webserver | ``false`` | Set to ``true`` to restart the webserver on config change *(etebase__systemd_setup needed)*|
| etebase__webserver_service | 'nginx.service' | Which systemd unit should be restartet for the webserver | | etebase__webserver_service | ``nginx.service`` | Which systemd unit should be restartet for the webserver |
| etebase__systemd_setup | false | Set to ``true`` to start etebase as systemd unit with the systemd socket configured above | | etebase__systemd_setup | ``false`` | Set to ``true`` to start etebase as systemd unit with the systemd socket configured above |
| submodules_versioncheck | false | should we do a simple version check for this ansible role | | submodules_versioncheck | ``false`` | should we do a simple version check for this ansible role |
Options for etebase-server.ini Options for etebase-server.ini
@ -39,19 +35,19 @@ What this Ansible role does not create are users in Etebase. And the configurati
| variable | value | description | | variable | value | description |
| -------- | ----- | ----------- | | -------- | ----- | ----------- |
| etebase__global_secret_file | '{{ etebase__secrets_dir }}/secret.txt' | path of secret.txt | etebase__global_secret_file | ``{{ etebase__secrets_dir }}/secret.txt`` | path of secret.txt
| etebase__global_debug | false | Set debug to true | | etebase__global_debug | ``false`` | Set debug to true |
| etebase__global_static_root | "{{ etebase__user_home }}/static_root" | Path of static root | | etebase__global_static_root | ``{{ etebase__user_home }}/static_root`` | Path of static root |
| etebase__global_media_root: "{{ etebase__user_home }}/media_root" | etebase__global_media_root | ``{{ etebase__user_home }}/media_root`` | Path for media |
| etebase__global_extra | '' | Variable for aditional parameter in the ``[global]`` section of the config file | | etebase__global_extra | | Variable for aditional parameter in the ``[global]`` section of the config file |
| etebase__allowed_hosts_allowed_host1 | '\*' | The allowed Host for this etebase server | | etebase__allowed_hosts_allowed_host1 | ``*`` | The allowed Host for this etebase server |
| etebase__allowed_hosts_extra | '' |Variable for aditional parameter in the ``[allowed_hosts]`` section of the config file | | etebase__allowed_hosts_extra | |Variable for aditional parameter in the ``[allowed_hosts]`` section of the config file |
| etebase__database_engine | 'django.db.backends.sqlite3' | Databse Engine | | etebase__database_engine | ``django.db.backends.sqlite3`` | Databse Engine |
| etebase__database_name | "{{ etebase__secrets_dir }}/etebase.db.sqlite3" | Path of the sqlite3 database | | etebase__database_name | "{{ etebase__secrets_dir }}/etebase.db.sqlite3" | Path of the sqlite3 database |
| etebase__database_extra | '' | Variable for aditional parametet in the ``[database]`` section of the config file | | etebase__database_extra | | Variable for aditional parametet in the ``[database]`` section of the config file |
| etebase__database_options_extra | '' | Variable for aditional parameter in the ``[database_options]`` section of the config file | | etebase__database_options_extra | | Variable for aditional parameter in the ``[database_options]`` section of the config file |
| etebase__ldap_extra | '' | Variable for aditional parameter in the ``[ldap]`` section of the config file | | etebase__ldap_extra | | Variable for aditional parameter in the ``[ldap]`` section of the config file |
| etebase__config_extra | '' |Variable for aditional parameter at the end of the config file | | etebase__config_extra | |Variable for aditional parameter at the end of the config file |
Additional Information Additional Information
------------------------ ------------------------
@ -65,3 +61,8 @@ cd etebase_v0.10.0 # example versiom
/var/lib/etebase/venv/bin/python3 ./manage.py createsuperuser /var/lib/etebase/venv/bin/python3 ./manage.py createsuperuser
``` ```
By the way, this role requires that the Ansible user be allowed to execute commands with sudo privileges.
Contributing
--------------
Don't hesitate to open a issue or *(even better)* create a pull request.