Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Readme #316

Merged
merged 2 commits into from
Jul 31, 2024
Merged

Update Readme #316

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7a842a
Update readme
fatihbaltaci Jul 31, 2024
19bd081
Update readme
fatihbaltaci Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions selfhosted/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,23 @@ This README provides instructions for installing and an overview of the system r
- **Memory**: 8 GB RAM or more
- **Storage**: At least 5 GB of available hard drive space (preferably SSD for faster load times)

## ⚡️ Quick Start (docker compose)
> [!NOTE]
> Only Linux and MacOS are supported at the moment. Windows is not supported.

You can quickly deploy Anteon Self Hosted by running the following command. This script clones the Anteon repository to your `$HOME/.anteon` directory, and deploys the services using Docker Compose. Please check the [install.sh](./install.sh) file to see what it does. You can also run the commands manually by following the [Manual Installation](#-manual-installation) section.
## Deploy with Docker Compose

Only Linux and MacOS are supported at the moment. Windows is not supported.
You can quickly deploy Anteon Self Hosted by running the following command. This script clones the Anteon repository to your `$HOME/.anteon` directory, and deploys the services using Docker Compose. Please check the [install.sh](./install.sh) file to see what it does. You can also run the commands manually by following the [Manual Installation](#-manual-installation) section.

> [!WARNING]
> Since Docker Compose deploys all the services on the same server, it is recommended to deploy Anteon Self-hosted on a Kubernetes cluster with our [Helm chart](https://github.com/getanteon/anteon-helm-charts).

Anteon Self Hosted starts in the background. You can access the dashboard at [http://localhost:8014](http://localhost:8014). The system is started always on boot if Docker is started. You can stop the system in the [Stop/Start the Services](#-stopstart-the-services) section.

```bash
curl -sSL https://raw.githubusercontent.com/getanteon/anteon/master/selfhosted/install.sh | bash
```

## 🚀 Deploy on Kubernetes
## Deploy on Kubernetes (Recommended)

You can deploy Anteon Self Hosted on Kubernetes using the [Helm chart](https://github.com/getanteon/anteon-helm-charts).

Expand Down
Loading