Sign inSign up

vsc55/webscrapbook

By vsc55

•Updated about 2 months ago

PyWebScrapBook server (WebScrapBook backend) on Alpine — multi-arch, non-root, env-configurable

Image
Web servers
Content management system
0

50K+

vsc55/webscrapbook repository overview

⁠docker-PyWebScrapBook

Docker image for the backend server of the WebScrapBook browser extension (a tool to capture and organize web pages), packaging PyWebScrapBook⁠ on Alpine. Multi-arch, runs as a non-root user, and is fully configurable via environment variables.

⁠Quick start

docker run -d --name PyWebScrapBook \
  -v /dockers/PyWebScrapBook_data:/data \
  -p 8080:8080/tcp \
  vsc55/webscrapbook:latest

Docker Compose:

services:
  webapp:
    image: vsc55/webscrapbook:latest
    ports:
      - "8080:8080"
    volumes:
      - webscrapbook_data:/data
    restart: unless-stopped

volumes:
  webscrapbook_data:

Then point the WebScrapBook browser extension at http://<host>:8080/ (Backend server options).

⁠Data layout (/data volume)

PathDescription
/data/store/Served scrapbook content. Put your scrapbook here.
/data/.wsb/config.iniGenerated configuration.
/data/.wsb/backup/Automatic backups.

⁠Configuration (environment variables)

Applied to config.ini on every boot (environment is the source of truth).

VariableDescription
HTTP_PORTListening port (default 8080).
WSB_AUTH_USEREnables HTTP Basic auth when set.
WSB_AUTH_PASSWORDPassword (stored hashed).
WSB_AUTH_PERMISSIONall (default) or read.
WSB_ALLOWED_X_FOR / _PROTO / _HOST / _PORT / _PREFIXTrusted reverse-proxy headers.
WSB_SSL_ON / WSB_SSL_CERT / WSB_SSL_KEY / WSB_SSL_PWHTTPS (cert/key relative to /data).
WSB_APP_NAME / WSB_THEME / WSB_LOCALESite title / theme / interface locale.

Full documentation: https://github.com/vsc55/docker-PyWebScrapBook#configuration-environment-variables⁠

⁠Tags

  • latest — the most recent release.
  • X.Y.Z — a specific WebScrapBook version (e.g. 2.9.0), recommended for reproducible deployments.

⁠Supported architectures

linux/386, linux/amd64, linux/arm64/v8, linux/arm/v7, linux/arm/v6

⁠Versioning & releases

The image tag is the WebScrapBook (product) version; the image itself has its own version. Release notes and the changelog are on GitHub: https://github.com/vsc55/docker-PyWebScrapBook/releases⁠

⁠License

GPL-3.0 — https://github.com/vsc55/docker-PyWebScrapBook/blob/master/LICENSE⁠

Tag summary

Content type

Image

Digest

sha256:207568a29…

Size

40.5 MB

Last updated

about 2 months ago

docker pull vsc55/webscrapbook