{"id":13447703,"url":"https://github.com/turtl/server","last_synced_at":"2026-02-20T20:39:00.111Z","repository":{"id":25445147,"uuid":"104019529","full_name":"turtl/server","owner":"turtl","description":"The new Turtl server","archived":false,"fork":false,"pushed_at":"2024-03-25T21:02:53.000Z","size":388,"stargazers_count":627,"open_issues_count":2,"forks_count":73,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-03-22T01:37:22.102Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/turtl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-19T03:04:25.000Z","updated_at":"2025-03-20T15:30:47.000Z","dependencies_parsed_at":"2024-10-28T12:19:18.092Z","dependency_job_id":"3011b438-f312-4ba2-8c02-ae29db5e7c67","html_url":"https://github.com/turtl/server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/turtl/server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turtl%2Fserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turtl%2Fserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turtl%2Fserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turtl%2Fserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/turtl","download_url":"https://codeload.github.com/turtl/server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turtl%2Fserver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29663476,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T19:49:36.704Z","status":"ssl_error","status_checked_at":"2026-02-20T19:44:05.372Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T05:01:24.786Z","updated_at":"2026-02-20T20:39:00.095Z","avatar_url":"https://github.com/turtl.png","language":"JavaScript","readme":"# Turtl server\n\n_Opening an issue? See the [Turtl project tracker](https://github.com/turtl/project-tracker/issues)_\n\nThis is the new Turtl server. It handles a number of things for Turtl clients:\n\n- Account management (join/login/delete)\n- Data storage\n- Syncing\n- Permissions and sharing\n\nIt implements a plugin architecture so things like analytics and payment\nprocessing can be used without forcing a particular method/service.\n\n## Running the server\n\nThe Turtl server requires [Node](https://nodejs.org/) \u003e= 8 and a [Postgres](https://www.postgresql.org/)\ninstance (\u003e= 9.6) with a dedicated user/db set up for it.\n\nOnce you have Node and Postgres set up, do the following:\n\n```sh\nmkdir turtl\ncd turtl\ngit clone https://github.com/turtl/server\ncd server/\nnpm install\ncp config/config.yaml.default config/config.yaml\n```\n\nNow edit `config/config.yaml` as needed.\nYou'll want to main get your `db` settings correct, and `uploads`/`s3` sections\nconfigured. Also, be sure to change `app.secure_hash_salt` _(unless you're going\nto be running the integration tests against this server)_.\n\nNow do:\n\n```sh\n# create the plugin directory from config.yaml#plugins.plugin_location\nmkdir /path/to/plugin/dir    # (usually just plugins/ in turtl/server/)\n./scripts/init-db.sh\nnode server.js\n```\n\nGreat, done.\n\n## Running the server (via docker-compose)\n\nYou only have to run the following docker-compose command:\n\n```sh\ndocker-compose up\n```\n\nIt will spawn a postgres database and the turtl server itself. Now you have a running turtl \nwhich is available under 'http://localhost:8181'. \n\nBe aware: after you cancel the docker-compose the data will be lost. For productive usage you may want\nto store the postgres-data inside a docker volume.\n\n### Configuration via ENV-Variables\nIn docker you may want to set each configuration value (for example the database) via environment\nvariables. You can override **each** default value via environment variable! Just create a variable named\nwith the prefix **TURTLE_** followed by the \"yaml-path\" written in UPPERCASE. For example: If you want\nto change the **app.api_url** value you have to define the variable name like **TURTL_APP_API_URL**.\n\nSome configuration values are explained in `config/config.yaml.default`.\n\n## Integration tests\n\nIf you want to run the [integration tests](https://github.com/turtl/core-rs/tree/master/integration-tests)\nagainst this instance of the server you need to do two things:\n\n1. Leave the `app.secure_hash_salt` value as it appears in `config.yaml.default`\n2. Run `node tools/populate-test.data.js`\n\n","funding_links":[],"categories":["JavaScript","others","Tools"],"sub_categories":["WebTools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturtl%2Fserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fturtl%2Fserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturtl%2Fserver/lists"}