mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 02:11:53 +00:00
86567e7fa5
* rename frontend to web and update contributing guide * rename this time * fix build * restructure rust code * update documentation * update descriptions * Update CONTRIBUTING.md Co-authored-by: J H <2364004+Blu-J@users.noreply.github.com> --------- Co-authored-by: Aiden McClelland <me@drbonez.dev> Co-authored-by: Aiden McClelland <3732071+dr-bonez@users.noreply.github.com> Co-authored-by: J H <2364004+Blu-J@users.noreply.github.com>
85 lines
4.2 KiB
Markdown
85 lines
4.2 KiB
Markdown
<div align="center">
|
|
<img src="web/projects/shared/assets/img/icon.png" alt="StartOS Logo" width="16%" />
|
|
<h1 style="margin-top: 0;">StartOS</h1>
|
|
<a href="https://github.com/Start9Labs/start-os/releases">
|
|
<img alt="GitHub release (with filter)" src="https://img.shields.io/github/v/release/start9labs/start-os?logo=github">
|
|
</a>
|
|
<a href="https://github.com/Start9Labs/start-os/actions/workflows/startos-iso.yaml">
|
|
<img src="https://github.com/Start9Labs/start-os/actions/workflows/startos-iso.yaml/badge.svg">
|
|
</a>
|
|
<a href="https://heyapollo.com/product/startos">
|
|
<img alt="Static Badge" src="https://img.shields.io/badge/apollo-review%20%E2%AD%90%E2%AD%90%E2%AD%90%E2%AD%90%E2%AD%90%20-slateblue">
|
|
</a>
|
|
<a href="https://twitter.com/start9labs">
|
|
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/start9labs">
|
|
</a>
|
|
<a href="https://mastodon.start9labs.com">
|
|
<img src="https://img.shields.io/mastodon/follow/000000001?domain=https%3A%2F%2Fmastodon.start9labs.com&label=Follow&style=social">
|
|
</a>
|
|
<a href="https://matrix.to/#/#community:matrix.start9labs.com">
|
|
<img alt="Static Badge" src="https://img.shields.io/badge/community-matrix-yellow?logo=matrix">
|
|
</a>
|
|
<a href="https://t.me/start9_labs">
|
|
<img alt="Static Badge" src="https://img.shields.io/badge/community-telegram-blue?logo=telegram">
|
|
</a>
|
|
<a href="https://docs.start9.com">
|
|
<img alt="Static Badge" src="https://img.shields.io/badge/docs-orange?label=%F0%9F%91%A4%20support">
|
|
</a>
|
|
<a href="https://matrix.to/#/#community-dev:matrix.start9labs.com">
|
|
<img alt="Static Badge" src="https://img.shields.io/badge/developer-matrix-darkcyan?logo=matrix">
|
|
</a>
|
|
<a href="https://start9.com">
|
|
<img alt="Website" src="https://img.shields.io/website?up_message=online&down_message=offline&url=https%3A%2F%2Fstart9.com&logo=website&label=%F0%9F%8C%90%20website">
|
|
</a>
|
|
</div>
|
|
<br />
|
|
<div align="center">
|
|
<h3>
|
|
Welcome to the era of Sovereign Computing
|
|
</h3>
|
|
<p>
|
|
StartOS is an open source Linux distribution optimized for running a personal server. It facilitates the discovery, installation, network configuration, service configuration, data backup, dependency management, and health monitoring of self-hosted software services.
|
|
</p>
|
|
</div>
|
|
<br />
|
|
<p align="center">
|
|
<img src="assets/StartOS.png" alt="StartOS" width="85%">
|
|
</p>
|
|
<br />
|
|
|
|
## Running StartOS
|
|
There are multiple ways to get started with StartOS:
|
|
|
|
### 💰 Buy a Start9 server
|
|
This is the most convenient option. Simply [buy a server](https://store.start9.com) from Start9 and plug it in.
|
|
|
|
### 👷 Build your own server
|
|
This option is easier than you might imagine, and there are 4 reasons why you might prefer it:
|
|
1. You already have hardware
|
|
1. You want to save on shipping costs
|
|
1. You prefer not to divulge your physical address
|
|
1. You just like building things
|
|
|
|
To pursue this option, follow one of our [DIY guides](https://start9.com/latest/diy).
|
|
|
|
## ❤️ Contributing
|
|
There are multiple ways to contribute: work directly on StartOS, package a service for the marketplace, or help with documentation and guides. To learn more about contributing, see [here](https://start9.com/contribute/).
|
|
|
|
To report security issues, please email our security team - security@start9.com.
|
|
|
|
## 🌎 Marketplace
|
|
There are dozens of services available for StartOS, and new ones are being added all the time. Check out the full list of available services [here](https://marketplace.start9.com/marketplace). To read more about the Marketplace ecosystem, check out this [blog post](https://blog.start9.com/start9-marketplace-strategy/)
|
|
|
|
## 🖥️ User Interface Screenshots
|
|
|
|
<p align="center">
|
|
<img src="assets/registry.png" alt="StartOS Marketplace" width="49%">
|
|
<img src="assets/community.png" alt="StartOS Community Registry" width="49%">
|
|
<img src="assets/c-lightning.png" alt="StartOS NextCloud Service" width="49%">
|
|
<img src="assets/btcpay.png" alt="StartOS BTCPay Service" width="49%">
|
|
<img src="assets/nextcloud.png" alt="StartOS System Settings" width="49%">
|
|
<img src="assets/system.png" alt="StartOS System Settings" width="49%">
|
|
<img src="assets/welcome.png" alt="StartOS System Settings" width="49%">
|
|
<img src="assets/logs.png" alt="StartOS System Settings" width="49%">
|
|
</p>
|