Opening an issue? See the Turtl project tracker
This is the new Turtl server. It handles a number of things for Turtl clients:
- Account management (join/login/delete)
- Data storage
- Permissions and sharing
It implements a plugin architecture so things like analytics and payment processing can be used without forcing a particular method/service.
Running the server
Once you have Node and Postgres set up, do the following:
mkdir turtl cd turtl git clone https://github.com/turtl/server cd server/ npm install cp config/config.yaml.default config/config.yaml
config/config.yaml as needed.
You'll want to main get your
db settings correct, and
configured. Also, be sure to change
app.secure_hash_salt (unless you're going
to be running the integration tests against this server).
# create the plugin directory from config.yaml#plugins.plugin_location mkdir /path/to/plugin/dir # (usually just plugins/ in turtl/server/) ./scripts/init-db.sh node server.js
Running the server (via docker-compose)
You only have to run the following docker-compose command:
It will spawn a postgres database and the turtl server itself. Now you have a running turtl which is available under 'http://localhost:8181'.
Be aware: after you cancel the docker-compose the data will be lost. For productive usage you may want to store the postgres-data inside a docker volume.
Configuration via ENV-Variables
In docker you may want to set each configuration value (for example the database) via environment variables. You can override each default value via environment variable! Just create a variable named with the prefix TURTLE_ followed by the "yaml-path" written in UPPERCASE. For example: If you want to change the app.api_url value you have to define the variable name like TURTL_APP_API_URL.
Some configuration values are explained in
If you want to run the integration tests against this instance of the server you need to do two things:
- Leave the
app.secure_hash_saltvalue as it appears in