Skip to main content

🏗️ Installing Laniakea

This guide will walk you through the process of installing Laniakea on your system.

Short version of guide

Important Note

Laniakea currently supports Docker-based installations only.

System Requirements​

Laniakea is designed to be lightweight and efficient. While it can run on modest hardware, we recommend the following specifications for optimal performance:

Minimum Requirements​

  • Architecture: x86_64 or arm64 processors
  • Memory: 512MB RAM
  • Storage: 1GB available disk space
  • Operating System: Any OS that supports Docker Engine
note

Need support for a different architecture? Contact support for assistance.

Installation Steps​

1. Install Docker Engine​

First, install Docker Engine using the official installation script:

curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh

2. Download Laniakea container image​

wget https://storage.laniakea.dev/laniakea-amd64-latest.tar -O laniakea.tar
docker load -i laniakea.tar

3. Configure Laniakea​

Create a configuration directory and download the default configuration file:

# Create configuration directory
sudo mkdir -p /etc/laniakea

# Download default configuration
sudo wget https://laniakea.dev/config.yaml -O /etc/laniakea/config.yaml
tip

Review and modify the configuration file according to your needs before proceeding with the installation.

4. Deploy Laniakea​

Run Laniakea using Docker:

docker run -d \
  --name laniakea \
  --restart unless-stopped \
  -p 80:80 \
  -v /etc/laniakea/:/etc/laniakea/ \
  laniakea
info

The above command:

  • Runs Laniakea in detached mode (-d)
  • Sets automatic restart policy (--restart unless-stopped)
  • Maps port 80 to the host
  • Mounts your configuration file

Verification​

After installation, verify that Laniakea is running properly:

docker ps | grep laniakea

You should see the Laniakea container running and can access the web interface at http://localhost.

⚡ TLDR​

# Install Docker
curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh
# Download Laniakea container image
wget https://storage.laniakea.dev/laniakea-amd64-latest.tar -O laniakea.tar
docker load -i laniakea.tar
mkdir /etc/laniakea
# Create configuration file
wget https://laniakea.dev/config.yaml -O /etc/laniakea/config.yaml
# Start Laniakea container
docker run -d \
  --name laniakea \
  --restart unless-stopped \
  -p 80:80 \
  -v /etc/laniakea/:/etc/laniakea/ \
  laniakea

Setting Up Nginx Reverse Proxy​

To run Laniakea behind an Nginx reverse proxy, follow these steps:

1. Install Nginx​

# For Debian/Ubuntu
sudo apt update && sudo apt install nginx

# For CentOS/RHEL
sudo yum install nginx

# For macOS
brew install nginx

2. Configure Nginx​

Create a new Nginx configuration file for Laniakea:

sudo nano /etc/nginx/sites-available/laniakea.conf
sudo ln -s /etc/nginx/sites-available/laniakea.conf /etc/nginx/sites-enabled/laniakea.conf

Add the following configuration:

server {
    listen 8080;
    server_name your-domain.com;  # Replace with your domain

    location / {
        proxy_pass http://localhost:8080;
    }
}

3. Modify Laniakea Configuration​

Update your Laniakea container to use a different port to avoid conflicts with Nginx:

docker run -d \
  --name laniakea \
  --restart unless-stopped \
  -p 8080:80 \
  -v /etc/laniakea/:/etc/laniakea/ \
  laniakea

4. Test and Restart Nginx​

Test the configuration and restart Nginx:

# Test configuration
sudo nginx -t

# Restart Nginx
sudo systemctl restart nginx  # For systemd-based systems
sudo service nginx restart   # For init.d-based systems
SSL/TLS Configuration

For production environments, we strongly recommend setting up SSL/TLS certificates. You can use Let's Encrypt with Certbot:

# Install Certbot
sudo apt install certbot python3-certbot-nginx  # For Ubuntu/Debian
sudo yum install certbot python3-certbot-nginx  # For CentOS

# Obtain and install certificate
sudo certbot --nginx -d your-domain.com
note

Remember to:

  1. Replace your-domain.com with your actual domain
  2. Configure your firewall to allow traffic on ports 80/443
  3. Update your DNS records to point to your server