EteBase Ansible Role - EteSync 2.0 Server Backend

This Ansible role helps set up and configure Etebase, the backend for EteSync version 2.0. You can find the source code at GitHub.

Overview

This role installs and configures Etebase, which allows you to securely sync your contacts, calendars, tasks, and notes. It creates a separate user for Etebase, downloads the latest version of Etebase to the user's home directory, sets up the configuration, and installs necessary Python dependencies in a virtual environment. Optionally, you can start Etebase automatically using systemd and uvicorn.

Please note that this role does not create users in Etebase or web server configurations. You can find more details in the Additional Information section.

Default Variables

Here are some default variables used in the role:

Options for etebase-server.ini

These options help configure Etebase’s settings:

Additional Information

For more about web server configuration, check Production setup using Nginx. Keep note of the value used for the etebase__socket variable if you start the uvicorn ASGI server using systemd (requires setting etebase__systemd_setup to true).

You need to create an admin user manually. Log in as a privileged user, navigate to etebase__user_home, enter the downloaded Etebase code directory, and run the following command in the virtual environment:

# Go to Etebase home
cd /var/lib/etebase/

# Move to the latest Etebase version
ls -l etebase_*
cd etebase_v0.10.0  # example version

# Activate the virtual environment
ls -l /var/lib/etebase/venv
source /var/lib/etebase/venv/v0.10.0/bin/activate  # example version

# Create new superuser
python3 ./manage.py createsuperuser

Make sure that the Ansible user has permission to run commands with sudo.

Example Playbook

Here is a sample playbook to install Etebase on example.com:

---
- name: Install Etebase server at example.com
  hosts: example.com
  roles:
    - {role: do1jlr.etebase, tags: etebase}
  vars:
    etebase__allowed_hosts_allowed_host1: 'example.com'
    etebase__systemd_setup: true
    submodules_versioncheck: true

Requirements

You need the community.general collection for some parts of this role. Install it with the following command:

ansible-galaxy collection install -r requirements.yml --upgrade

Contributing

Feel free to open an issue or create a pull request if you have suggestions or improvements!