{"id":13638609,"url":"https://github.com/Native-Planet/anchor","last_synced_at":"2025-04-19T18:30:46.967Z","repository":{"id":59345778,"uuid":"536781355","full_name":"Native-Planet/anchor","owner":"Native-Planet","description":"Self-hosted StarTram service -- access GroundSeg-hosted ships from anywhere","archived":false,"fork":false,"pushed_at":"2023-12-14T04:13:03.000Z","size":75,"stargazers_count":52,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-09T08:40:02.484Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Native-Planet.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}},"created_at":"2022-09-14T22:37:36.000Z","updated_at":"2024-09-21T04:01:42.000Z","dependencies_parsed_at":"2023-12-14T05:25:50.400Z","dependency_job_id":"a2136cbf-25e8-4ae1-97ba-a1468af92450","html_url":"https://github.com/Native-Planet/anchor","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2Fanchor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2Fanchor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2Fanchor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2Fanchor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Native-Planet","download_url":"https://codeload.github.com/Native-Planet/anchor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249764719,"owners_count":21322288,"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","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-08-02T01:00:50.037Z","updated_at":"2025-04-19T18:30:46.710Z","avatar_url":"https://github.com/Native-Planet.png","language":"Shell","funding_links":[],"categories":["Shell","Developer Tools"],"sub_categories":[],"readme":"![](https://nyc3.digitaloceanspaces.com/startram/anchor.png)\n\n# Native Planet self-hosted Anchor\n\nThis is a self-hostable version of the NativePlanet anchor service, a single-tenant version of the subscription StarTram service. Anchor is meant to host a single [GroundSeg](https://nativeplanet.io/software) client, but there are no limits on the number of piers it can host. The installer script is meant to be run on Debian/Ubuntu, but it should work on other distros if you have Python 3 \u0026 Ansible installed. \n\nCredit for initial concept due to [odyslam](https://github.com/odyslam) for the [home-urbit](https://github.com/odyslam/home-urbit) project, implemented by Native Planet\n\n### How to use\n\nYou'll need set a few things up ahead of time:\n\n- Spin up a VPS (e.g. [DigitalOcean](https://m.do.co/c/94f7fdc03fad) or [Vultr](https://www.vultr.com/?ref=9235764)) and make note of the IP address\n  - This package is designed to run on Ubuntu 22.04; it works well with typical ~$5 1GB/1CPU instances though could work reasonably on a 512MB/1CPU instance.\n  - The playbook will automatically provision 2GB swap -- this doesn't work on some hosts, so if it breaks it, just comment out those lines and try again.\n- Register a domain (you can re-use an existing one, you'll only be using subdomains)\n\nCreate the following 5 `A` records for your domain, assigned to your VPS's IP address:\n  - `anchor.yourdomain.com` -- the anchor URL your NP will connect to\n  - `ship-name.yourdomain.com` -- The URL of your ship's name\n  - `s3.ship-name.yourdomain.com` -- These 3 subdomains for Minio\n  - `console.s3.ship-name.yourdomain.com`\n  - `bucket.s3.ship-name.yourdomain.com`\n\nIf you want to run multiple ships, create new subdomains for them (you only need one `anchor` record).\n\nMake sure you can connect to the VPS over SSH as root with an SSH key.\n- If you don't have a key, you can generate one with `ssh-keygen -t ed25519 -m PEM -f id_ed25519`\n- Copy the contents of your public key from `id_ed25519.pub`\n- Get the public key for your keyfile with `ssh-keygen -f ./id_ed25519 -y` if you don't see one\n- Connect to your VPS, and use `sudo su -` to switch to `root`\n- Open `/root/.ssh/authorized_keys` in a text editor and paste in the public key for your key\n- Run `systemctl restart sshd`\n\nClone this git repository on your local computer:\n\n```\ngit clone https://github.com/Native-Planet/anchor.git\ncd anchor\n```\n\nOpen the `settings.sh` file in a text editor and edit the variables, with the root of your domain (`yourdomain.com`), `REG_CODE` as the code you'll use to register your device (🚨 **change this!** 🚨), and the path to the pem file you just generated.\n\nRun `./install.sh` to execute the installer script; it will connect to your VPS (using the `anchor.yourdomain.com` IP address) and download and configure all of the software automatically. Wait until the ansible playbook has completed -- this might take a few minutes on low-spec servers.\n\nOn your NativePlanet, go to the settings menu and under the Anchor submenu, select 'custom endpoint' and enter `anchor.yourdomain.com`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNative-Planet%2Fanchor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNative-Planet%2Fanchor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNative-Planet%2Fanchor/lists"}