HUB
Sign inSign up
storage-service logo

shellui/storage-service

By shellui

•Updated 4 days ago

Storage service for Shellui, the web app development platform.

Image
0

1.6K

shellui/storage-service repository overview

⁠Run storage-service

storage-service stores company files for a Shellui app and serves them at /storage/v1/. You call the same paths as Supabase Storage. Use this page to run the shellui/storage-service image.

⁠What is inside the image

The entrypoint starts as root, prepares /app/data, and runs the app as appuser.

ItemValue
Basepython:3.14-slim
Listen port8000
Entrypoint/app/tools/docker-entrypoint.sh
App processesappuser
Volume/app/data (SQLite and filesystem blobs)

Node.js 22 builds the CSS during the image build, and the final image includes that file. The default command is web: migrate, then Gunicorn and the scheduler. The image sets DEBUG=false and STORAGE_BACKEND=filesystem.

⁠Start a container

Set IDENTITY_SERVICE_URL, IDENTITY_ISSUER, and IDENTITY_AUDIENCE from identity-service. Set REDIS_URL to a Redis URL the container can reach. Replace your_secret_key_here with a key of at least 50 characters. An empty POSTGRES_DATABASE_URL uses SQLite on the volume.

This command maps port 8000 and stores data in a named volume:

docker run --rm -p 8000:8000 \
  -v storage-data:/app/data \
  -e SECRET_KEY=your_secret_key_here \
  -e DEBUG=false \
  -e ALLOWED_HOSTS=storage.example.com \
  -e CSRF_TRUSTED_ORIGINS=https://storage.example.com \
  -e IDENTITY_SERVICE_URL=https://id.example.com \
  -e IDENTITY_ISSUER=https://id.example.com \
  -e IDENTITY_AUDIENCE=your_jwt_audience_here \
  -e REDIS_URL=redis://your_redis_host_here:6379/0 \
  -e POSTGRES_DATABASE_URL= \
  shellui/storage-service:0.8.0

This Compose file starts Redis in the same project and stores data in storage-data:

services:
  storage-service:
    image: shellui/storage-service:0.8.0
    ports:
      - "8000:8000"
    environment:
      SECRET_KEY: your_secret_key_here
      DEBUG: "false"
      ALLOWED_HOSTS: storage.example.com
      CSRF_TRUSTED_ORIGINS: https://storage.example.com
      IDENTITY_SERVICE_URL: https://id.example.com
      IDENTITY_ISSUER: https://id.example.com
      IDENTITY_AUDIENCE: your_jwt_audience_here
      REDIS_URL: redis://redis:6379/0
      POSTGRES_DATABASE_URL: ""
    volumes:
      - storage-data:/app/data
    depends_on:
      - redis
  redis:
    image: redis:8-alpine
volumes:
  storage-data:

The app redirects HTTP to HTTPS. GET /health/live stays on HTTP and skips Django host checks. Set ALLOWED_HOSTS to localhost, and set SECURE_SSL_REDIRECT=false, for an HTTP trial on your machine.

⁠Required environment variables

config/env_registry.py requires these when DEBUG=false. The image already sets that. Match issuer and audience to the JSON Web Token (JWT) claims that identity-service signs.

VariableExamplePurpose
SECRET_KEYyour_secret_key_hereSigns sessions and cross-site request forgery (CSRF) tokens, at least 50 characters
DEBUGfalseProduction mode (the image default)
ALLOWED_HOSTSstorage.example.comPublic host names, comma-separated, no scheme
CSRF_TRUSTED_ORIGINShttps://storage.example.comFull HTTPS origin for Django admin CSRF checks
IDENTITY_SERVICE_URLhttps://id.example.comidentity-service origin for server-side calls
IDENTITY_ISSUERhttps://id.example.comMust match identity-service JWT_ISSUER
IDENTITY_AUDIENCEyour_jwt_audience_hereMust match identity-service JWT_AUDIENCE
REDIS_URLredis://redis:6379/0Shared cache and job broker
POSTGRES_DATABASE_URLemptyPostgreSQL URL, or empty for SQLite

For every other variable, read the configuration reference⁠. That page covers S3, quotas, Shellui Actions webhooks, and JSON Web Key Set (JWKS) pinning.

⁠Image tags

A GitHub release pushes a linux/amd64 and linux/arm64 index. A manual workflow dispatch pushes the same tags. A stable semver tag, such as v0.8.0, becomes latest when it is the highest stable tag.

A release tag maps to these image tags:

TagWhen
0.8.0Release tag v0.8.0, leading v removed
0.8Major and minor from that same tag
latestStable three-part tag, such as 0.8.0, when that version is the highest stable tag

⁠Health check

The image health check calls GET /health/live on port 8000. The body is ok, with no token, database, or Redis. GET /storage/v1/health returns status and version.

Source, handbook, changelog, license, and the Shellui site:

Tag summary

Content type

Image

Digest

sha256:69e97ca6d…

Size

251.1 MB

Last updated

4 days ago

docker pull shellui/storage-service