# Getting Started

Welcome to the Cosmos documentation. There are two ways to run Cosmos

 * (BETA) as a standalone service on your system. This will be the recommended way to run Cosmos moving forward, as it will allow you to use all of its features. It is currently still new, so if you find an issue with the installtion, please report it on Discord or Github! Go to the [standalone service](#install-cosmos-as-a-standalone-service) section to learn how to install Cosmos this way.

 * as a Docker container. This is the easiest way to run Cosmos, but it will limit some of its features. Especially for the storage management. Go to the [Docker container](#install-cosmos-as-a-docker-container) section to learn how to install Cosmos this way.

## Install Cosmos as a standalone service

### Automatic installation

You can install Cosmos with the following command:

```bash
# IF YOU NEED TO CHANGE THE PORTS, DO IT BEFORE RUNNING THE COMMAND
# You can overwrite any other env var by adding them here
export COSMOS_HTTP_PORT=80
export COSMOS_HTTPS_PORT=443

# You can run a dry run to see what will be installed
curl -fsSL https://cosmos-cloud.io/get.sh | sudo -E bash -s -- --dry-run

# If you are happy with the result, you can run the command
curl -fsSL https://cosmos-cloud.io/get.sh | sudo -E bash -s
```

This command will install/update dependencies such as Snapraid, Avahi, Docker, Docker-Compose, ... and finally install Cosmos as a service. It will also check your firewall setup and start the service. You can check the script [here](https://cosmos-cloud.io/get.sh). Before running it.

If Cosmos fails to start, you can either check the logs with `sudo journalctl -u CosmosCloud` or check the logs in the config folder at `/var/lib/cosmos/cosmos.log`.

Finally, you can see the logs directly by starting Cosmos manually with

```bash
sudo /opt/cosmos/cosmos
```

### Manual installation

If you prefer to install Cosmos manually, you can follow the following steps:

1. Install Docker and Docker-Compose. You can find the installation instructions on the [official Docker website](https://docs.docker.com/engine/installation/).

2. Install dependencies

```bash
# for debian/ubuntu
sudo apt-get update
sudo apt-get install -y ca-certificates openssl fdisk mergerfs snapraid

# for centos
sudo yum install -y ca-certificates openssl fdisk mergerfs snapraid

# for fedora
sudo dnf install -y ca-certificates openssl fdisk mergerfs snapraid

# for arch
sudo pacman -Sy ca-certificates openssl fdisk mergerfs snapraid
```

3. Download the latest release of Cosmos from the [GitHub releases page](https://github.com/azukaar/Cosmos-Server/releases) and extract it to a folder of your choice.

4. Run the following command to start Cosmos:

```bash
cd /path/to/cosmos
sudo ./cosmos service install
sudo systemctl start CosmosCloud
```

This will create a systemd service for Cosmos and start it.

### Management

The resulting Cosmos daemon is a systemd service. You can manage it with the following commands:

```bash
sudo systemctl start CosmosCloud
sudo systemctl stop CosmosCloud
sudo systemctl restart CosmosCloud
sudo systemctl status CosmosCloud

# If you want to see the system logs
sudo journalctl -u CosmosCloud
```

You can also find the logs directly **in the config page** OR in the config folder:

```bash
# If you want to see the Cosmos logs
cat /var/lib/cosmos/cosmos.log

# If you want to see the plain logs (without the terminal formatting)
cat /var/lib/cosmos/cosmos.plain.log
```


# Getting Started


Welcome to the Cosmos documentation. There are two ways to run Cosmos


 * (BETA) as a standalone service on your system. This will be the recommended way to run Cosmos moving forward, as it will allow you to use all of its features. It is currently still new, so if you find an issue with the installtion, please report it on Discord or Github! Go to the [standalone service](#install-cosmos-as-a-standalone-service) section to learn how to install Cosmos this way.


 * as a Docker container. This is the easiest way to run Cosmos, but it will limit some of its features. Especially for the storage management. Go to the [Docker container](#install-cosmos-as-a-docker-container) section to learn how to install Cosmos this way.


## Install Cosmos as a standalone service


### Automatic installation


You can install Cosmos with the following command:


```bash
# IF YOU NEED TO CHANGE THE PORTS, DO IT BEFORE RUNNING THE COMMAND
# You can overwrite any other env var by adding them here
export COSMOS_HTTP_PORT=80
export COSMOS_HTTPS_PORT=443


# You can run a dry run to see what will be installed
curl -fsSL https://cosmos-cloud.io/get.sh | sudo -E bash -s -- --dry-run


# If you are happy with the result, you can run the command
curl -fsSL https://cosmos-cloud.io/get.sh | sudo -E bash -s
```


This command will install/update dependencies such as Snapraid, Avahi, Docker, Docker-Compose, ... and finally install Cosmos as a service. It will also check your firewall setup and start the service. You can check the script [here](https://cosmos-cloud.io/get.sh). Before running it.


If Cosmos fails to start, you can either check the logs with `sudo journalctl -u CosmosCloud` or check the logs in the config folder at `/var/lib/cosmos/cosmos.log`.


Finally, you can see the logs directly by starting Cosmos manually with


```bash
sudo /opt/cosmos/cosmos
```


### Manual installation


If you prefer to install Cosmos manually, you can follow the following steps:


1. Install Docker and Docker-Compose. You can find the installation instructions on the [official Docker website](https://docs.docker.com/engine/installation/).


2. Install dependencies


```bash
# for debian/ubuntu
sudo apt-get update
sudo apt-get install -y ca-certificates openssl fdisk mergerfs snapraid


# for centos
sudo yum install -y ca-certificates openssl fdisk mergerfs snapraid


# for fedora
sudo dnf install -y ca-certificates openssl fdisk mergerfs snapraid


# for arch
sudo pacman -Sy ca-certificates openssl fdisk mergerfs snapraid
```


3. Download the latest release of Cosmos from the [GitHub releases page](https://github.com/azukaar/Cosmos-Server/releases) and extract it to a folder of your choice.


4. Run the following command to start Cosmos:


```bash
cd /path/to/cosmos
sudo ./cosmos service install
sudo systemctl start CosmosCloud
```


This will create a systemd service for Cosmos and start it.


### Management


The resulting Cosmos daemon is a systemd service. You can manage it with the following commands:


```bash
sudo systemctl start CosmosCloud
sudo systemctl stop CosmosCloud
sudo systemctl restart CosmosCloud
sudo systemctl status CosmosCloud


# If you want to see the system logs
sudo journalctl -u CosmosCloud
```


You can also find the logs directly **in the config page** OR in the config folder:


```bash
# If you want to see the Cosmos logs
cat /var/lib/cosmos/cosmos.log


# If you want to see the plain logs (without the terminal formatting)
cat /var/lib/cosmos/cosmos.plain.log
```