Installation

Using Docker

The preferred way for installing and using Sopho is through Docker.

Run the following command to pull the Docker image:

docker pull ghcr.io/sopho-tech/sopho/sopho:latest

After the image has been pulled, run the container:

docker run -d -p 8000:8000 \
  --name sopho \
  -e ADMIN_USERNAME="admin" \
  -e ADMIN_PASSWORD="password" \
  -e ADMIN_EMAIL="admin@admin.com" \
  -e ADMIN_FULL_NAME="admin admin" \
  ghcr.io/sopho-tech/sopho/sopho:latest

Production Usage

The container will use SQLite as the backend database by default. SQLite is not recommended for production usage. Use PostgreSQL for production. More details on fine tuning can be found at Configuration.

From Source

Not Recommended

Building from source is intended for development and contribution. For production or general use, Docker is the preferred installation method.

Prerequisites

Before building Sopho from source, ensure you have the following installed:

Requirement	Version	Purpose
Rust + Cargo	1.75 or later	Backend compilation
Node.js	18 or later (LTS recommended)	Frontend build tooling
npm	10 or later (bundled with Node.js)	Frontend dependencies
Make	Any	Build automation

Verify your setup:

rustc --version
node --version
npm --version
make --version

Clone the Repository

git clone https://github.com/sopho-tech/sopho.git
cd sopho

Build

From the repository root, build both the frontend and backend:

make install

Configuration

Properties can be fine tuned using environment variables described in Configuration.

Run

To start Sopho:

make run