||2 months ago|
|.github||2 years ago|
|docker||6 months ago|
|etebase_server||3 months ago|
|requirements.in||3 months ago|
|.dockerignore||2 years ago|
|.gitignore||7 months ago|
|ChangeLog.md||2 months ago|
|LICENSE||5 years ago|
|README.md||7 months ago|
|etebase-server.ini.example||6 months ago|
|icon.svg||4 years ago|
|manage.py||7 months ago|
|mypy.ini||2 years ago|
|pyproject.toml||7 months ago|
|requirements-dev.txt||6 months ago|
|requirements.txt||3 months ago|
|setup.py||2 months ago|
Etebase - Encrypt Everything
An Etebase (EteSync 2.0) server so you can run your own.
Etebase requires Python 3.7 or newer and has a few Python dependencies (listed in
Before installing the Etebase server make sure you install
virtualenv (for Python 3):
- Arch Linux:
pacman -S python-virtualenv
apt-get install python3-virtualenv
- Mac/Windows (WSL)/Other Linux: install virtualenv or just skip the instructions mentioning virtualenv.
Then just clone the git repo and set up this app:
git clone https://github.com/etesync/server.git etebase cd etebase # Set up the environment and deps virtualenv -p python3 .venv # If doesn't work, try: virtualenv3 .venv source .venv/bin/activate pip install -r requirements.txt
If you are familiar with Django you can just edit the settings file
according to the Django deployment checklist.
If you are not, we also provide a simple configuration file for easy deployment which you can use.
To use the easy configuration file rename it to
etebase-server.ini and place it either at the root of this repository or in
There is also a wikipage detailing this basic setup.
Some particular settings that should be edited are:
ALLOWED_HOSTS-- this is the list of host/domain names or addresses on which the app will be served. For example:
DEBUG-- handy for debugging, set to
MEDIA_ROOT-- the path to the directory that will hold user data.
SECRET_KEY-- an ephemeral secret used for various cryptographic signing and token generation purposes. See below for how default configuration of
SECRET_KEYworks for this project.
Now you can initialise our django app.
And you are done! You can now run the debug server just to see everything works as expected by running:
uvicorn etebase_server.asgi:application --host 0.0.0.0 --port 8000
Using the debug server in production is not recommended, so please read the following section for a proper deployment.
There are more details about a proper production setup using uvicorn and Nginx in the wiki.
The webserver should also be configured to serve Etebase using TLS. A guide for doing so can be found in the wiki as well.
The Etebase server needs to be aware of the URL it's been served as, so make sure to forward the
Host header to the server if using a reverse proxy. For example, you would need to use the following directive in nginx:
proxy_set_header Host $host;.
Data locations and backups
The server stores user data in two different locations that need to be backed up:
- The database - how to backup depends on which database you use.
MEDIA_ROOT- the path where user data is stored.
Create yourself an admin user:
At this stage you need to create accounts to be used with the EteSync apps. To do that, please go to:
www.your-etesync-install.com/admin and create a new user to be used with the service. No need to set
a password, as Etebase uses a zero-knowledge proof for authentication, so the user will just create
a password when creating the account from the apps.
After this user has been created, you can use any of the EteSync apps to signup (or login) with the same username and email in order to set up the account. The password used at that point will be used to setup the account. Don't forget to set your custom server address under "Advanced".
The default configuration creates a file “
secret.txt” in the project’s
base directory, which is used as the value of the Django
setting. You can revoke this key by deleting the
secret.txt file and the
next time the app is run, a new one will be generated. Make sure you keep
secret.txt file secret (e.g. don’t accidentally commit it to version
control). However, backing it up is okay, and it makes it easier to restore
the database to a new EteSync server, but it's not essential. If you want to
change to a more secure system for storing secrets, edit
and implement your own method for setting
SECRET_KEY (remove the line
where it uses the
get_secret_from_file function). Read the Django docs
for more information about the
SECRET_KEY and its uses.
Updating from version 0.5.0 onwards
git pull --rebase to update this repository.
Then, inside the virtualenv:
pip install -U -r requirements.txtto update the dependencies.
python manage.py migrateto perform database migrations.
You can now restart the server.
Updating from version 0.5.0 or before
The 0.5.0 release marks the change to the EteSync 2.0 protocol. EteSync 2.0 accounts are substantially different to 1.0 accounts, and require additional upgrade steps. In addition, the servers are incompatible, so 0.5.0 requires a fresh installation.
Here are the update steps:
- Chose any of the the migration tools and make sure the underlying apps are up to date with all of your data. So for example, if you are using the Android client, make sure to sync before commencing.
- Install the 0.5.0 version to a new path (you can't reuse the same database).
- Run the 0.5.0 account and create the appropriate users as described in the installation/upgrade steps above.
- Run the migration tool to migrate all of your data.
- Add your new EteSync 2.0 accounts to all of your devices.
Docker images named
:latest are available for testing etesync clients.
This docker image starts a server on port 3735 that supports user signup (without email confirmation), is in debug mode (thus supporting the reset endpoint), and stores its data locally.
It is in no way suitable for production usage, but is able to start up quickly and makes a good component of CI for etesync clients and users of those clients.
Instead of having to create Django users manually when signup up Etebase users, it is also possible to allow automatic signup. For example, this makes sense when putting an Etebase server in production. However, this does come with the added risk that everybody with access to your server will be able to sign up.
In order to set it up, comment out the line
ETEBASE_CREATE_USER_FUNC = "etebase_server.django.utils.create_user_blocked" in
server/settings.py and restart your Etebase server.
Etebase is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation. See the LICENSE for more information.
A quick summary can be found on tldrlegal. Though in even simpler terms (not part of the license, and not legal advice): you can use it in however way you want, including self-hosting and commercial offerings as long as you release the code to any modifications you have made to the server software (clients are not affected).
For commercial licensing options, contact email@example.com
Financially Supporting Etebase
Please consider registering an account even if you self-host in order to support the development of Etebase, or visit the contribution for more information on how to support the service.
Become a financial contributor and help us sustain our community!