{"id":28543457,"url":"https://github.com/owntracks/quicksetup","last_synced_at":"2025-07-27T03:33:40.374Z","repository":{"id":219732173,"uuid":"749707741","full_name":"owntracks/quicksetup","owner":"owntracks","description":"A (mostly) automated installer for OwnTracks Recorder, Frontend with MQTT and Let's Encrypt","archived":false,"fork":false,"pushed_at":"2025-06-16T11:32:22.000Z","size":2804,"stargazers_count":27,"open_issues_count":4,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-06T10:40:26.687Z","etag":null,"topics":["acme","ansible","configuration","frontend","mqtt","owntracks","recorder"],"latest_commit_sha":null,"homepage":"https://owntracks.org/booklet/guide/quicksetup/","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/owntracks.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog","contributing":null,"funding":null,"license":null,"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":"2024-01-29T08:32:43.000Z","updated_at":"2025-06-23T15:16:03.000Z","dependencies_parsed_at":"2024-02-23T17:24:53.816Z","dependency_job_id":"cfb32014-2237-4f83-a1b5-5058a09ffd9d","html_url":"https://github.com/owntracks/quicksetup","commit_stats":null,"previous_names":["owntracks/quicksetup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/owntracks/quicksetup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owntracks%2Fquicksetup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owntracks%2Fquicksetup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owntracks%2Fquicksetup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owntracks%2Fquicksetup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/owntracks","download_url":"https://codeload.github.com/owntracks/quicksetup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owntracks%2Fquicksetup/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267294180,"owners_count":24065343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["acme","ansible","configuration","frontend","mqtt","owntracks","recorder"],"created_at":"2025-06-09T21:09:09.411Z","updated_at":"2025-07-27T03:33:40.355Z","avatar_url":"https://github.com/owntracks.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quicksetup\n\nOwnTracks allows you to keep track of your own location. You can build your private location diary or share it with your family and friends. OwnTracks is open-source and uses open protocols for communication so you can be sure your data stays secure and private.\n\n![Quicksetup will configure this](files/assets/owntracks-quicksetup-arch.png)\n\nThe components required to use the free OwnTracks apps are non-trivial to setup. For this reason we have created this project: _quicksetup_ is a set of tools which, when run on a suitable small computer or VPS, will should get your OwnTracks environment set up as comfortably as possible.\n\nQuicksetup [is documented in the OwnTracks Booklet](https://owntracks.org/booklet/guide/quicksetup/)\n\n## requirements\n\n- VPS (512MB RAM) with Linux. Debian (12) or Ubuntu (Jammy, Mantic, Noble)\n- alternatively, a Raspberry Pi with Raspbian _bookworm_\n- a DNS domain name pointing to the Linux machine\n- three open TCP ports (80, 443, 8883)\n\n## features\n\n- Let's Encrypt certificate enrollment and renewal (cron)\n- MQTT broker (Mosquitto) and HTTP server (Apache) secured with SSL/TLS\n- OwnTracks [Recorder](https://github.com/owntracks/recorder)\n  - configured for MQTT\n  - with support for HTTP POST for location publishes from OwnTracks clients\n- configured [Frontend](https://github.com/owntracks/frontend)\n- automatic configuration of friends, each of which can see eachother via MQTT in the apps and on Frontend, etc.\n- configuration of any number of friends\n  - users are created with random passwords added to files in file system, `htpasswd`, and Mosquitto password file\n  - users can download pre-configured [.otrc remote configuration files](https://owntracks.org/booklet/features/remoteconfig/) or click on a URL config for ease of configuration of the apps. Preconfigured with choice of MQTT and HTTP\n  - optional configuration of a secret key per user for payload encryption\n- optional but recommended configuration of [OpenCageData](https://opencagedata.com/) for reverse geo in Recorder defaults file and in `.otrc` for Android devices. (Sign up for [a free account](https://opencagedata.com/users/sign_up) you use with OwnTracks.) Location data is cached by the Recorder and stored alongside location publishes, served from the API\n- should be able to support a dozen or more friends on a 512MB VPS\n- `mosquitto_pub`/`mosquitto_sub` pre-configured to use local broker with files in `$HOME/.config/`\n- `jq(1)` and `jo(1)` commands for working with JSON\n- bootstrapping of installation\n- Recorder Views (without requiring basic auth)\n- support for optional:\n   - Recorder Lua script\n- explicitly no support for:\n   - [MQTT over websockets](https://github.com/owntracks/quicksetup/issues/3), even though our apps support it\n\n## installation\n\n1. Get a copy of all files in this repository:\n   1. either install git and clone the repository:\n      ```console\n      apt install -y git\n      git clone https://github.com/owntracks/quicksetup\n      cd quicksetup\n      ```\n   2. or download a copy of the files and extract them:\n      ```console\n      curl -LO https://github.com/owntracks/quicksetup/archive/master.tar.gz\n      tar xf master.tar.gz\n      cd quicksetup-main\n      ```\n\n2. Make a copy of the [configuration file](configuration.yaml.example) used for setup and edit its content.\n   ```console\n   cp configuration.yaml.example configuration.yaml\n   nano configuration.yaml\n   ```\n\n3. Launch the installer which will install packages and configure services.\n   ```console\n   $ sudo ./bootstrap.sh\n   ```\n\nIf you later decide you wish to add a friend to `configuration.yaml`, just run the installer again: `./bootstrap.sh`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowntracks%2Fquicksetup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fowntracks%2Fquicksetup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowntracks%2Fquicksetup/lists"}