Hosting Scopes

When building your on-site hosting for Bit scopes, we recommend using a solution like Docker. This guide will walk you through the various aspects of managing multiple scopes, their storage, and how to ensure backup and monitoring.

In this guide you will use the base images provided by Bit as a platform.

• bit-cli container is an image generated with each new release of Bit. It includes the latest version of Bit pre-installed.
• bare-scope container is an image that uses the bit-cli container and provides a bare scope.

If you prefer building your own image, you can use this base dockerfile as a starter:

FROM node:12.22.0
USER root

RUN npm i @teambit/bvm -g
RUN bvm upgrade
ENV PATH=$PATH:/root/bin

# increase memory to avoid 137 error code
ENV NODE_OPTIONS=--max_old_space_size=4096

RUN bit config set analytics_reporting false
RUN bit config set no_warnings false
RUN bit config set interactive false
RUN bit config set error_reporting true

ARG SCOPE_PATH=/root/remote-scope
WORKDIR ${SCOPE_PATH}
RUN bit init --bare
CMD bit start
Copied

Start by using the bitcli/bit-server to setup a scope:

docker run -it -p {host-port}:3000 bitcli/bit-server:latest
Copied

Now open your browser and go to:

http://localhost:{host-port}
Copied

To export components to the scope, add it as a remote to your workstation:

bit remote add http://localhost:{host-port}
Copied

In your project's workspace.json file configure the defaultScope according to the scope name.
Use the export command to share your components:

bit export
Copied

Set a specific version for your server by using the BIT_VERSION argument:

docker build -f ./Dockerfile-bit-server --build-arg BIT_VERSION={version} -t bitcli/bit-server:{version} .
Copied

The scope name is defined by the folder name of the containing scope (remote-scope by default). This name is then later used for setting it up in the workspace.jsonc file. In case you want to change it you can pass the build arg called SCOPE_PATH like --build-arg SCOPE_PATH=/root/custom-remote-scope

To persist the scope data, you need the scope folder to be mounted from the host. You can use bind mounts for example:

docker run -it -v {scope-path-on-host}:/root/remote-scope -p {host-port}:3000 bitcli/bit-server:latest
Copied

It's recommended to use volumes or have an orchestrator like kubernetes handle mounts.

When combining a change of the scope name/location and volume, you have to make sure the location provided in the SCOPE_PATH in the build arg is matching the target in the volume:

docker run -it -v {scope-path-on-host}:/root/custom-remote-scope -build-arg SCOPE_PATH=/root/custom-remote-scope -p {host-port}:3000 bitcli/bit-server:latest
Copied

See the /root/custom-remote-scope is used both in the -v arg after the : and as the SCOPE_PATH value.

Since the bit start command at the moment can't be run as detached, you will need a way to run it as the main command and to monitor the logs at the same time.

You can mount the logs directory on the container to a directory in the host.

For example:

docker run -it -v {logs-dir-on-host}:/root/Library/Caches/Bit/logs -p {host-port}:3000 bitcli/bit-server:latest
Copied

It's recommended to use tmpfs-mounts.

A Scope handles export and import operations. To make you components installable as packages (npm install/bit install) configure them to be published to a package registry.