Quickstart

Prerequisites

Before you begin, make sure you have the following :

1. Lancer Installed on your system.
2. Postgres Database A PostgreSQL instance to store metadata about uploaded files.
3. Redis (optional) A Redis server for caching uploaded files and enhancing performance.

Setting up Lancer

After a successfull installation you can see the configuration files for Lancer in the following directory :

1. Windows : C:\Users\<username>\AppData\Roaming\Lancer
2. Linux : /home/<username>/.config/Lancer
3. MacOS : /Users/<username>/Library/Application Support/Lancer

Configuration

Add a basic configuration file lancer.yaml in that folder

lancer.yaml

port: "8080"
database:
  address: "localhost:5432"
  user: "lancer_user"
  password: "secure_password_123"
  name: "lancer_db"

use-redis: true
redis: "redis://localhost:6379"

server-auth: false
webhook-endpoint: "http://localhost:3000/webhook"
auth-endpoint: "http://localhost:3000/auth"

store:
  local:
    path: "store"
    temp-path: "temp"
  aws:
    store: true
    bucket: "my-lancer-bucket"
    region: "us-east-1"
    clientId: "" # AWS Client ID
    clientSecret: "" # AWS Client Secret

admin-token-secret: "supersecretkey123"
auth:
  email: "admin@lancer.com"
  password: "adminpassword123"

**If using custom configuration : **

lancer --config=lancer.yaml --database-migrate=true

This will apply the migration to the database.

Start the server

You can start the lancer server using the cli or a Systemd service in linux .

1. Windows : You can start lancer by running this command :

lancer

Just make sure lancer is added in your system environment variables.

1. Linux : You can start lancer by running this command :

• Systemd Service :

  sudo systemctl start lancer

  If you get any error running this command, make sure you have already setup a service using this command :

  lancer setup-service
  sudo systemctl daemon-reload
  sudo systemctl start lancer

  Check if the server running using this command :

  sudo systemctl status lancer

• By CLI :

  lancer

  This will start the lancer server.

Access the dashboard

Now you can visit and login into the lancer dashboard which is running at port 8080 by default.

Visit Dashboard