A basic EteSync service (so you can run your own)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kumy de71aaa476 Fix typo in README 1 month ago
etesync_server Add an index page to make it more obvious it works. 6 months ago
example-configs/nginx-uwsgi added missing closing bracket 2 months ago
templates Add an index page to make it more obvious it works. 6 months ago
.gitignore Use secret.txt file auto-generated in project root as default SECRET_KEY 1 year ago
LICENSE Initial commit: add license. 2 years ago
README.md Fix typo in README 1 month ago
etesync-server.ini.example Fix issue with etesync-server.ini always being loaded. 4 months ago
icon.svg README: Add etesync logo. 10 months ago
manage.py Initial commit of the actual server code. 2 years ago
requirements.txt Deps: update drf. 6 months ago

README.md

EteSync - Secure Data Sync

A skeleton app for running your own EteSync server

Installation

Using pre-built packages

From source

Before installing the EteSync server make sure you install virtualenv (for Python 3):

  • Arch Linux: pacman -S python-virtualenv
  • Debian/Ubuntu: apt-get install python3-virtualenv
  • Mac/Windows/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-skeleton.git

cd server-skeleton

# 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

Configuration

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 etesync-server.ini and place it either at the root of this repository or in /etc/etesync-server.

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
  • DEBUG -- handy for debugging, set to False for production
  • SECRET_KEY -- an ephemeral secret used for various cryptographic signing and token generation purposes. See below for how default configuration of SECRET_KEY works for this project.

Now you can initialise our django app

./manage.py migrate

And you are done! You can now run the debug server just to see everything works as expected by running:

./manage.py runserver 0.0.0.0:8000

Using the debug server in production is not recommended, so please read the following section for a proper deployment.

Production deployment

EteSync is based on Django so you should refer to one of the following

The webserver should also be configured to serve EteSync using TLS.

There are more details about a proper production setup in the wiki.

Usage

Create yourself an admin user:

./manage.py createsuperuser

At this stage you can either just use the admin user, or better yet, go to: www.your-etesync-install.com/admin and create a non-privileged user that you can use.

That’s it!

Now all that’s left is to open the EteSync app, add an account, and set your custom server address under the “advance” section.

SECRET_KEY and secret.txt

The default configuration creates a file “secret.txt” in the project’s base directory, which is used as the value of the Django SECRET_KEY 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 the secret.txt file secret (don’t accidentally commit it to version control, exclude it from your backups, etc.). If you want to change to a more secure system for storing secrets, edit etesync_server/settings.py 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

First, run git pull --rebase to update this repository. Then, inside the virtualenv:

  1. Run pip install -U -r requirements.txt to update the dependencies.
  2. Run python manage.py migrate to perform database migrations.

You can now restart the server.

Supporting EteSync

Please consider registering an account even if you self-host in order to support the development of EteSync, or help by spreading the word.