How to install Scrapbox enterprise
This guide is for developers and people with experience using Docker, Docker Compose, and Linux.
is only available for people using Docker images managed with Docker Hub. It requires the following environment:
A machine with Docker installed.
For macOS, we recommend
Docker for mac
An account at
(Please use your Docker Hub ID and make sure your settings allow you to pull images.)
Authenticate using your Docker login in the environment where you want to launch Scrapbox.
Standard version (latest) and proxy version
Standard version (latest)
For the standard version, use this.
If you cannot authenticate using the standard version (if you need to access the network through a proxy), use this.
For the Docker images in the explanation below, rewrite and read 'notainc/scrapbox' as 'notainc/scrapbox:proxy'.
Google authentication will not work for technical reasons. (Only GitHub, including GitHub Enterprise, will be used.)
Installation and initial settings
Folder creation and transfer
Name the folder
(Docker will use the folder name as the container name.)
Move to the created folder ('cd scrapbox')
and store it in the
$ docker run --rm notainc/scrapbox cat docker-compose.yml > docker-compose.yml
Specify the Scrapbox host name (including the http:// etc.) in 'APP_URL' (required).
Set 'SECRET_TOKEN' as a random, unguessable character string (required).
This will be used to encrypt your session key.
Github enterprise authentication settings
Register OAuth Application in GitHub (GHE)
Rewrite the part in the blue box in the image above with the app URL you set (same as 'APP_URL').
In the illustration above, the URL is
; we recommend that you first check to see if it acts as a localhost, then use a host name such as
for actual activity.
Set the callback URL (the second part in the blue box in the image above) as
APP_URL + /auth/github/callback
Obtain OAuth's Client ID and secret.
Set them to
Designate the GHE host name (including the http:// etc.) as
Mongo DB's save destination
It's set to
by default; change it as necessary.
in the second half is the internal path for the container, so please don't change it.
Be careful; deleting this folder will erase all data.
: When running Docker Compose on sudo,
will change, so please specify the appropriate path.
If using the
, add the following setting directly below
services: > web: > environment:
For the standard version, the
setting is unnecessary.
Run the following command in the directory where you downloaded docker-compose.yml:
$ docker-compose up
Running as a daemon
$ docker-compose up -d
If running as a daemon:
$ docker-compose down
How to use Scrapbox
Refer people to this project (
Obtain the latest image from Docker Hub
Terminate the container, then next time, use
to run from the new image
docker-compose up -d
Procedure for Backing up the On-Premises Version
Why use Docker Hub?
It's the most widely-used Docker image distribution source.
Can be basically managed with
commands only, but not Docker commands.