Hoppscotch

Official

Docker app from grtgbln's Repository

Overview

Open source API development ecosystem, alternative to Postman and Insomnia.

Requirements

Requires a separate Postgres database.

Runtime arguments

Web UI: http://[IP]:[PORT:3100]/
Network: bridge
Privileged: false

Template configuration

Admin UI PortPorttcp

Container Port: 3100

Target: 3100
Default: 3100
Value: 3100

Frontend PortPorttcp

Container Port: 3000

Target: 3000
Default: 3000
Value: 3000

Backend PortPorttcp

Container Port: 3170

Target: 3170
Default: 3170
Value: 3170

Database URLVariable

Postgres database URL

Target: DATABASE_URL
Default: postgresql://username:password@url:5432/dbname
Value: postgresql://username:password@url:5432/dbname

Auth Tokens - JWT SecretVariable

JWT secret for authentication tokens

Target: JWT_SECRET

Auth Tokens - Session SecretVariable

Session secret for authentication tokens

Target: SESSION_SECRET

Data Encryption KeyVariable

Key for data encryption in database. Must be 32 characters.

Target: DATA_ENCRYPTION_KEY

Redirect URLVariable

Redirect URL for authentication

Target: REDIRECT_URL
Default: http://localhost:3000
Value: http://localhost:3000

Whitelisted OriginsVariable

Comma-separated list of whitelisted URLs for authentication. Include three ports used by Hoppscotch.

Target: WHITELISTED_ORIGINS
Default: http://localhost:3000,http://localhost:3100,http://localhost:3170
Value: http://localhost:3000,http://localhost:3100,http://localhost:3170

Enabled Auth ProvidersVariable

Comma-separated list of enabled authentication providers. Options: GOOGLE, GITHUB, MICROSOFT, EMAIL

Target: VITE_ALLOWED_AUTH_PROVIDERS

Google Auth - Client IDVariable

Google OAuth client ID. Delete if not using Google authentication.

Target: GOOGLE_CLIENT_ID

Google Auth - Client SecretVariable

Google OAuth client secret. Delete if not using Google authentication.

Target: GOOGLE_CLIENT_SECRET

Google Auth - Callback URLVariable

Google OAuth callback URL. Delete if not using Google authentication.

Target: GOOGLE_CALLBACK_URL
Default: http://localhost:3170/v1/auth/google/callback
Value: http://localhost:3170/v1/auth/google/callback

Google Auth - ScopeVariable

Google OAuth scope. Delete if not using Google authentication.

Target: GOOGLE_SCOPE
Default: email,profile
Value: email,profile

GitHub Auth - Client IDVariable

GitHub OAuth client ID. Delete if not using GitHub authentication.

Target: GITHUB_CLIENT_ID

GitHub Auth - Client SecretVariable

GitHub OAuth client secret. Delete if not using GitHub authentication.

Target: GITHUB_CLIENT_SECRET

GitHub Auth - Callback URLVariable

GitHub OAuth callback URL. Delete if not using GitHub authentication.

Target: GITHUB_CALLBACK_URL
Default: http://localhost:3170/v1/auth/github/callback
Value: http://localhost:3170/v1/auth/github/callback

GitHub Auth - ScopeVariable

GitHub OAuth scope. Delete if not using GitHub authentication.

Target: GITHUB_SCOPE
Default: user:email
Value: user:email

Microsoft Auth - Client IDVariable

Microsoft OAuth client ID. Delete if not using Microsoft authentication.

Target: MICROSOFT_CLIENT_ID

Microsoft Auth - Client SecretVariable

Microsoft OAuth client secret. Delete if not using Microsoft authentication.

Target: MICROSOFT_CLIENT_SECRET

Microsoft Auth - Callback URLVariable

Microsoft OAuth callback URL. Delete if not using Microsoft authentication.

Target: MICROSOFT_CALLBACK_URL
Default: http://localhost:3170/v1/auth/microsoft/callback
Value: http://localhost:3170/v1/auth/microsoft/callback

Microsoft Auth - ScopeVariable

Microsoft OAuth scope. Delete if not using Microsoft authentication.

Target: MICROSOFT_SCOPE
Default: user.read
Value: user.read

Microsoft Auth - TenantVariable

Microsoft OAuth tenant. Delete if not using Microsoft authentication.

Target: MICROSOFT_TENANT
Default: common
Value: common

Mailer - EnableVariable

Enable email sending for authentication.

Target: MAILER_SMTP_ENABLE
Default: false|true

Mailer- Use Custom ConfigsVariable

Use custom SMTP configurations.

Target: MAILER_USE_CUSTOM_CONFIGS
Default: false|true

Mailer - From AddressVariable

Sender email address.

Target: MAILER_ADDRESS_FROM
Default: from@example.com
Value: from@example.com

Mailer - SMTP URLVariable

SMTP server URL.

Target: MAILER_SMTP_URL
Default: smtps://user@domain.com:pass@smtp.domain.com
Value: smtps://user@domain.com:pass@smtp.domain.com

Mailer - SMTP HostVariable

SMTP server host if custom configs is enabled.

Target: MAILER_SMTP_HOST
Default: smtp.domain.com
Value: smtp.domain.com

Mailer - SMTP PortVariable

SMTP server port if custom configs is enabled.

Target: MAILER_SMTP_PORT
Default: 587
Value: 587

Mailer - SMTP SecureVariable

SMTP secure connection if custom configs is enabled.

Target: MAILER_SMTP_SECURE
Default: true|false

Mailer - SMTP UsernameVariable

SMTP username if custom configs is enabled.

Target: MAILER_SMTP_USER
Default: user@domain.com
Value: user@domain.com

Mailer - SMTP PasswordVariable

SMTP password if custom configs is enabled.

Target: MAILER_SMTP_PASS

Mailer - TLS Reject UnauthorizedVariable

Reject unauthorized TLS connections if custom configs is enabled.

Target: MAILER_TLS_REJECT_UNAUTHORIZED
Default: true|false

Frontend - Base URLVariable

Base URL for the application

Target: VITE_BASE_URL
Default: http://IP_ADDRESS:3000
Value: http://IP_ADDRESS:3000

Frontend - Shortcode Base URLVariable

Base URL for shortcode sharing, can be the same as Base URL.

Target: VITE_SHORTCODE_BASE_URL
Default: http://IP_ADDRESS:3000
Value: http://IP_ADDRESS:3000

Frontend - Admin URLVariable

Admin URL for the application

Target: VITE_ADMIN_URL
Default: http://IP_ADDRESS:3100
Value: http://IP_ADDRESS:3100

Backend - GraphQL URLVariable

GraphQL URL for the application

Target: VITE_BACKEND_GQL_URL
Default: http://IP_ADDRESS:3170/graphql
Value: http://IP_ADDRESS:3170/graphql

Backend - WebSockets URLVariable

WebSockets URL for the application

Target: VITE_BACKEND_WS_URL
Default: wss://IP_ADDRESS:3170/graphql
Value: wss://IP_ADDRESS:3170/graphql

Backend - API URLVariable

API URL for the application

Target: VITE_BACKEND_API_URL
Default: http://IP_ADDRESS:3170/v1
Value: http://IP_ADDRESS:3170/v1

Rate Limit - TTLVariable

Time, in seconds, it takes to refresh the maximum number of requests being received

Target: RATE_LIMIT_TTL
Default: 60
Value: 60

Rate Limit - Max RequestsVariable

Maximum number of requests per IP under the TTL

Target: RATE_LIMIT_MAX
Default: 100
Value: 100

Auth Tokens - Salt ComplexityVariable

Salt complexity for authentication tokens

Target: TOKEN_SALT_COMPLEXITY
Default: 10
Value: 10

Auth Tokens - Magic Link Token ValidityVariable

Duration, in days, for magic link tokens

Target: MAGIC_LINK_TOKEN_VALIDITY
Default: 3
Value: 3

Auth Tokens - Refresh Token ValidityVariable

Duration, in milliseconds, for refresh tokens

Target: REFRESH_TOKEN_VALIDITY
Default: 604800000
Value: 604800000

Auth Tokens - Access Token ValidityVariable

Duration, in milliseconds, for access tokens

Target: ACCESS_TOKEN_VALIDITY
Default: 86400000
Value: 86400000

Allow Secure CookiesVariable

Set to false if using http. Some auth providers may not support http requests and may stop working when set to false.

Target: ALLOW_SECURE_COOKIES
Default: false|true

Subpath Access Mode PortVariable

This is an optional variable that lets you specify an alternate port for the container’s endpoint when operating in subpath access mode. By default, this endpoint is exposed on port 80.

Target: HOPP_AIO_ALTERNATE_PORT
Default: 80
Value: 80

Target: VITE_APP_TOS_LINK
Default: https://docs.hoppscotch.io/support/terms
Value: https://docs.hoppscotch.io/support/terms

Target: VITE_APP_PRIVACY_POLICY_LINK
Default: https://docs.hoppscotch.io/support/privacy
Value: https://docs.hoppscotch.io/support/privacy

App TitleVariable

Title of the app

Target: TITLE
Default: Wedding Share
Value: Wedding Share

Logo URLVariable

URL of the logo

Target: LOGO
Default: https://raw.githubusercontent.com/nwithan8/unraid_templates/master/images/wedding-share-icon.png
Value: https://raw.githubusercontent.com/nwithan8/unraid_templates/master/images/wedding-share-icon.png

Gallery Column CountVariable

Number of columns in the gallery

Target: GALLERY_COLUMNS
Default: 4
Value: 4

Allowed File TypesVariable

Comma separated list of allowed file types

Target: ALLOWED_FILE_TYPES
Default: .jpg,.jpeg,.png
Value: .jpg,.jpeg,.png

Max File SizeVariable

Maximum file size in MB

Target: MAX_FILE_SIZE_MB
Default: 10
Value: 10

Secret KeyVariable

Secret key to combat strangers uploading. Optional, but recommended.

Target: SECRET_KEY

Disable UploadVariable

Disable the ability to upload files

Target: DISABLE_UPLOAD
Default: false|true

Disable QR CodeVariable

Disable the sharable QR code

Target: DISABLE_QR_CODE
Default: false|true

Hide Secret Key from QR CodeVariable

Hide the secret key from the QR code

Target: HIDE_KEY_FROM_QR_CODE
Default: false|true

Disable Home LinkVariable

Disable the home link

Target: DISABLE_HOME_LINK
Default: false|true

Uploads pathPath

Path to uploaded files

Target: /app/wwwroot/uploads
Default: /mnt/user/appdata/wedding_share/uploads
Value: /mnt/user/appdata/wedding_share/uploads

Links

Template Support Docker Hub Project

Details

Repository

hoppscotch/hoppscotch:latest

Registry

https://hub.docker.com/r/hoppscotch/hoppscotch

Last Updated2026-04-30

First Seen2025-02-15

Run Hoppscotch on Unraid.

Hoppscotch is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS