A skeleton app for running your own [Etebase](https://www.etebase.com) server
@@ -9,7 +9,7 @@ A skeleton app for running your own [Etebase](https://www.etebase.com) server
## From source
-Before installing the EteSync server make sure you install `virtualenv` (for **Python 3**):
+Before installing the Etebase server make sure you install `virtualenv` (for **Python 3**):
* Arch Linux: `pacman -S python-virtualenv`
* Debian/Ubuntu: `apt-get install python3-virtualenv`
@@ -18,9 +18,10 @@ Before installing the EteSync server make sure you install `virtualenv` (for **P
Then just clone the git repo and set up this app:
```
-git clone https://github.com/etesync/server-skeleton.git
+git clone https://github.com/etesync/server.git etebase
-cd server-skeleton
+cd etebase
+git checkout etebase
# Set up the environment and deps
virtualenv -p python3 venv # If doesn't work, try: virtualenv3 venv
@@ -32,8 +33,11 @@ pip install -r requirements.txt
# Configuration
If you are familiar with Django you can just edit the [settings file](etesync_server/settings.py)
-according to the [Django deployment checklist](https://docs.djangoproject.com/en/dev/howto/deployment/checklist/)
-if you are not, we will soon provide a simple configuration file for easy deployment like we had with EteSync.
+according to the [Django deployment checklist](https://docs.djangoproject.com/en/dev/howto/deployment/checklist/).
+If you are not, we also provide a simple [configuration file](https://github.com/etesync/server/blob/etebase/etebase-server.ini.example) 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 `/etc/etebase-server`.
+
+There is also a [wikipage](https://github.com/etesync/server/wiki/Basic-Setup-Etebase-(EteSync-v2)) detailing this basic setup.
Some particular settings that should be edited are:
* [`ALLOWED_HOSTS`](https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-ALLOWED_HOSTS)
@@ -46,7 +50,7 @@ will be served
generation purposes. See below for how default configuration of
`SECRET_KEY` works for this project.
-Now you can initialise our django app
+Now you can initialise our django app.
```
./manage.py migrate
@@ -62,14 +66,14 @@ Using the debug server in production is not recommended, so please read the foll
# Production deployment
-EteSync is based on Django so you should refer to one of the following
+There are more details about a proper production setup using Daphne and Nginx in the [wiki](https://github.com/etesync/server/wiki/Production-setup-using-Daphne-and-Nginx).
+
+Etebase is based on Django so you should refer to one of the following
* The instructions of the Django project [here](https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/).
* Instructions from uwsgi [here](http://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html).
-There are more details about a proper production setup using uWSGI and Nginx in the [wiki](https://github.com/etesync/server/wiki/Production-setup-using-uWSGI-and-Nginx).
-
The webserver should also be configured to serve Etebase using TLS.
-A guide for doing so can be found in the [wiki](https://github.com/etesync/server/wiki/Setup-HTTPS-for-EteSync) as well.
+A guide for doing so can be found in the [wiki](https://github.com/etesync/server/wiki/Setup-HTTPS-for-Etebase) as well.
# Usage
diff --git a/icon.svg b/icon.svg
new file mode 100644
index 0000000..4827d1d
--- /dev/null
+++ b/icon.svg
@@ -0,0 +1,241 @@
+
+
-