Skip to content
Slink Docs

Quick Start Guide

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have Docker installed on your system.

Installation

Section titled “Installation”

  1. Create a new directory for Slink and navigate to it:

    Terminal window
    mkdir slink-app && cd slink-app

  2. Run the following docker command to start the Slink application:

    Terminal window
    docker run -d \
     --name slink \
     -p 3000:3000 \
     -v ./slink/var/data:/app/var/data \
     -v ./slink/images:/app/slink/images \
     -e ORIGIN=https://your-domain.com \
     -e TZ=UTC \
     -e USER_APPROVAL_REQUIRED=false \
     -e IMAGE_MAX_SIZE=15M \
     -e STORAGE_PROVIDER=local \
     anirdev/slink:latest

  3. Open your browser and navigate to https://your-domain.com:3000/profile/signup to create a new account.

  4. (Optional) If you have USER_APPROVAL_REQUIRED=true, activate your user account:

    Terminal window
    docker exec -it slink slink user:activate --email=<user-email>

  5. (Optional) Grant yourself admin access by running the following command:

    Terminal window
    docker exec -it slink slink user:grant:role --email=<user-email> ROLE_ADMIN

  6. Login to the Slink application and start uploading images.