ByteStash

v1.0.0

A code snippet storage solution written in React & node.js

development productivity by HomerSimpson3k

x-arcane:
  icon: https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/bytestash.svg
  urls:
    - https://github.com/jordan-dalby/ByteStash

services:
  bytestash:
    image: ghcr.io/jordan-dalby/bytestash:latest
    container_name: bytestash
    hostname: bytestash
    restart: unless-stopped
    volumes:
      - /path/to/snippets:/data/snippets
    networks:
      - bytestash
    ports:
      - 5000:5000
    env_file: .env
    labels:
      com.getarcaneapp.arcane.icon: https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/bytestash.svg

networks:
  bytestash:
    external: false

# See https://github.com/jordan-dalby/ByteStash/wiki/FAQ#environment-variables
#ALLOWED_HOSTS="localhost,my.domain.com,my.domain.net"
BASE_PATH=""
ADMIN_USERNAMES=""
#JWT_SECRET_FILE=
JWT_SECRET=""
TOKEN_EXPIRY=24h
ALLOW_NEW_ACCOUNTS="true"
DEBUG="false"
DISABLE_ACCOUNTS="false"
DISABLE_INTERNAL_ACCOUNTS="false"

# See https://github.com/jordan-dalby/ByteStash/wiki/Single-Sign%E2%80%90on-Setup for more info
OIDC_ENABLED="false"
OIDC_DISPLAY_NAME=""
OIDC_ISSUER_URL=""
OIDC_CLIENT_ID=""
OIDC_CLIENT_SECRET=""
OIDC_SCOPES=""

README

Activate OIDC

To activate OIDC follow the setup instructions and set the according variables in .env file.

Generate secret token

Add a JWT_SECRET. You can create a random token by running:

openssl rand -base64 32

in your command line. You can alternatively set a JWT_SECRET_FILE.

Add admin users

When accessing the app for the first time you will have to create a user. You can add the username (or multiple usernames separated by comma) in ADMIN_USERNAMES to allow this user(s) to access the Admin panel.

Env variables

To learn more about the configurable environment variables you can visit ByteStash's FAQ site.