{"id":13638995,"url":"https://github.com/Native-Planet/GroundSeg","last_synced_at":"2025-04-19T21:35:18.725Z","repository":{"id":59903753,"uuid":"526958096","full_name":"Native-Planet/GroundSeg","owner":"Native-Planet","description":"The best way to run an Urbit ship","archived":false,"fork":false,"pushed_at":"2025-04-14T18:55:34.000Z","size":40522,"stargazers_count":51,"open_issues_count":21,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-14T19:45:46.977Z","etag":null,"topics":["selfhosting","urbit"],"latest_commit_sha":null,"homepage":"https://nativeplanet.io/software","language":"Go","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.md","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,"zenodo":null}},"created_at":"2022-08-20T15:00:11.000Z","updated_at":"2025-04-14T18:55:37.000Z","dependencies_parsed_at":"2023-09-22T04:13:58.600Z","dependency_job_id":"4153ecf0-bb13-4e56-8f8d-c6e45467a2d8","html_url":"https://github.com/Native-Planet/GroundSeg","commit_stats":null,"previous_names":[],"tags_count":417,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2FGroundSeg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2FGroundSeg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2FGroundSeg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Native-Planet%2FGroundSeg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Native-Planet","download_url":"https://codeload.github.com/Native-Planet/GroundSeg/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249811171,"owners_count":21328752,"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":["selfhosting","urbit"],"created_at":"2024-08-02T01:00:56.459Z","updated_at":"2025-04-19T21:35:18.716Z","avatar_url":"https://github.com/Native-Planet.png","language":"Go","funding_links":[],"categories":["Operations"],"sub_categories":["Arvo"],"readme":"# Native Planet GroundSeg\n\n![Groundseg 2 demo](https://user-images.githubusercontent.com/16911914/271397025-f534f6e3-5c62-4b9a-8cb9-9f1d07e5c29a.gif)\n\n#### See the user manual [here](https://manual.groundseg.app) for usage documentation\n\nGroundSeg is a software tool that helps users manage and access their multiple Urbit instances. \nIt simplifies the process of getting onto the Urbit network and provides a range of additional services \nthat enhance the functionality of the user's ship. With a [StarTram](https://www.nativeplanet.io/startram) \nsubscription, users can also access their Urbit ship remotely.\n\nNative Planet develops GroundSeg to run on our [dedicated Urbit-hosting home devices](https://www.nativeplanet.io)! \n\n## Dependencies\n\n- `docker`\n- `systemd`\n\n### Semi-dependencies\n\nThese are optional external packages for used wifi support:\n\n- `hostapd`\n- `nmcli`\n\n## Installation\n\n**Disclaimer:** GroundSeg runs with `sudo` privileges on your device. This is required for controlling various aspects of the device. For this reason, we recommend a dedicated device.\n\n### Docker + GroundSeg (Recommended)\nThis installs `docker` and the GroundSeg binary. Use this if you do not know what you're doing.\n\n```\nsudo wget -O - get.groundseg.app | bash\n```\n\n### Groundseg Only\n\nThis downloads the appropriate service file for you init system and the groundseg binary. Docker has to already be installed.\n\n```\nsudo wget -O - only.groundseg.app | bash\n```\n\n### Switching to the `edge` release channel (Unstable)\n\n1. In `/opt/nativeplanet/groundseg/settings/system.json`, set `\"updateBranch\"` to `\"edge\"`\n2. `sudo systemctl restart groundseg`\n\n## Building From Source\n\n1. Have docker installed\n2. run `build.sh`\n\n## Removing GroundSeg (Uninstall)\n\n### Standard Removal (Recommended)\nThis removes `docker`, `docker-compose`, GroundSeg related docker containers and images, and the GroundSeg system files.\nThis **DOES NOT** remove the docker volumes on the device.\n\n```\nmkdir -p /tmp/nativeplanet \u0026\u0026 \\\nsudo wget -O /tmp/nativeplanet/standard_uninstall.sh \\\nhttps://raw.githubusercontent.com/Native-Planet/GroundSeg/master/release/standard_uninstall.sh \u0026\u0026 \\\nsudo chmod +x /tmp/nativeplanet/standard_uninstall.sh \u0026\u0026 \\\nsudo /tmp/nativeplanet/standard_uninstall.sh\n```\n\n### Groundseg Only\n\nThis removes GroundSeg related docker containers and images, and the GroundSeg system files.\n\n```\nmkdir -p /tmp/nativeplanet \u0026\u0026 \\\nsudo wget -O /tmp/nativeplanet/groundseg_uninstall.sh \\\nhttps://raw.githubusercontent.com/Native-Planet/GroundSeg/master/release/groundseg_uninstall.sh \u0026\u0026 \\\nsudo chmod +x /tmp/nativeplanet/groundseg_uninstall.sh \u0026\u0026 \\\nsudo /tmp/nativeplanet/groundseg_uninstall.sh\n```\n\n### Uninstall and clear data\nThis removes `docker`, `docker-compose`, **ALL** docker images, containers and volumes, and the GroundSeg system files.\nThis wipes all docker and GroundSeg data. Make sure you have exported the data you want saved.\n\n```\nmkdir -p /tmp/nativeplanet \u0026\u0026 \\\nsudo wget -O /tmp/nativeplanet/complete_uninstall.sh \\\nhttps://raw.githubusercontent.com/Native-Planet/GroundSeg/master/release/complete_uninstall.sh \u0026\u0026 \\\nsudo chmod +x /tmp/nativeplanet/complete_uninstall.sh \u0026\u0026 \\\nsudo /tmp/nativeplanet/complete_uninstall.sh\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNative-Planet%2FGroundSeg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNative-Planet%2FGroundSeg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNative-Planet%2FGroundSeg/lists"}