Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fatihbaltaci committed Jul 31, 2024
1 parent 92e03ac commit a7a842a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions selfhosted/README.md
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 installs all the services on the same server, it is recommended to use Kubernetes for production environments.
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

0 comments on commit a7a842a

Please sign in to comment.