Installation

Astroluma can be installed on Virtual Machines, VPSs, Cloud Servers, EC2, Droplets and/or Docker. Docker is the recommended and fastest way to get started.

Install on Docker

Using Docker Hub image is the easiest way to install Astroluma. It requires that you have Docker and Docker-compose already installed.

• Docker Install documentation
• Docker-Compose Install documentation

Docker Image

1. Create a docker-compose.yml file similar to this:

docker-compose.yml

version: '3.8'

services:
  app:
    image: sanjeet990/astroluma:latest
    container_name: astroluma
    ##ports:
    ##  - "8000:8000"
    environment:
      PORT: 8000
      NODE_ENV: production
      SECRET_KEY: a2c5f9a8b2d7e1a7f2c9c8d9b5f7a3d5
      MONGODB_URI: mongodb://localhost:27017/astroluma
    volumes:
      - uploads_data:/app/storage/uploads
    depends_on:
      - mongodb
    restart: always
    network_mode: host

  mongodb:
    image: mongo:6.0
    container_name: astroluma_mongodb
    ports:
      - "27017:27017"
    volumes:
      - mongo_data:/data/db
    restart: always


volumes:
  mongo_data:
    driver: local
  uploads_data:
    driver: local

2. Bring up your stack by running:

docker-compose up -d

If using docker-compose-plugin:

docker compose up -d

Github

1. Clone from the official Astroluma Github Repo

Quick Tip

Main branch is the most stable branch. development branch is the code for active development.

git clone https://github.com/Sanjeet990/Astroluma

Now navigate to the Astroluma directory:

cd Astroluma

2. Build and start Astroluma:

docker-compose up --build -d

3. On completion of the step, Astroluma is running on port 8000. So if the IP is 192.168.29.4, visit http://192.168.29.4:8000/login

The default credential for the first user (admin) is:

Default credential

• Username: admin (Case Sensitive)
• Password: 123456

Install on Virtual Machines

To install on Virtual Machine / VPS / EC2 / Droplets without Docker, you need NodeJS and a Process Manager. For Process Manager, PM2 is recommended.

On Ubuntu Server

1. Install NodeJS:

• Install NodeJS on Ubuntu
• Installing MongoDB on Ubuntu

Pro Tip

Instead of installing MongoDB, you can use MongoDB Atlas or MongoDB TurnKey instance.

At this point, you should have a server with NodeJS installed and a MongoDB server.

2. Clone from the official Astroluma Github Repo

Quick Tip

Main branch is the most stable branch. development branch is the code for active development.

git clone https://github.com/Sanjeet990/Astroluma

Now navigate to the Atroluma directory:

cd Astroluma

3. Install dependencies:

npm install

4. Install PM2:

npm install pm2 -g

5. Build client:

cd client
npm run build

6. Once build is completed, navigate to server directory and create a .env file in the server directory with these keys

cd ../server

MONGODB_URI=<MongoDB URI>
SECRET_KEY=<32 Character long random key>

6. Start the server using PM2:

pm2 start server.js

Install on Local Machine

1. Install NodeJS:

• Install NodeJS on Ubuntu
• Installing MongoDB on Ubuntu

Pro Tip

Instead of installing MongoDB, you can use MongoDB Atlas or MongoDB TurnKey instance.

At this point, you should have a server with NodeJS installed and a MongoDB server.

2. Clone from the official Astroluma Github Repo

Quick Tip

Main branch is the most stable branch. development branch is the code for active development.

git clone https://github.com/Sanjeet990/Astroluma

Now navigate to the Atroluma directory:

cd Astroluma

3. Install dependencies:

npm install

4. Create a .env file in the server directory with these keys:

MONGODB_URI=<MongoDB URI>
SECRET_KEY=<32 Character long random key>

5. Create a .env file in the client directory with these keys:

VITE_API_BASE_URL=http://localhost:8000
VITE_API_WS_URL=ws://localhost:8000

5. Start the backend:

npm run dev:be

6. Start the frontend:

npm run dev:fe