Docker Compose

Estimated time: < 10 minutes

๐Ÿ“˜

Early access

The Sublime Platform is currently in early access. You can request early access here.

In order to complete the installation, you'll need a secrets file provided by the Sublime team.

Docker Compose

The Sublime Platform can be deployed locally on a laptop or remotely to a VPS in the cloud using Docker Compose.

Below are the minimum system requirements.

Number of mailboxes

RAM

CPUs

Storage

10

4GB

1

10GB

100

4GB

2

20GB

1000

8GB

4

50GB

Have more than 1,000 mailboxes? The AWS CloudFormation deployment auto-scales to any number of mailboxes.

Setup

Verify Docker is running:

docker -v

Output:

Docker version 20.10.2, build 2291f61

Verify Docker Compose is running:

docker-compose -v

Output:

docker-compose version 1.27.4, build 40524192

git clone https://github.com/sublime-security/sublime-platform.git && cd sublime-platform/

4. Move your sublime.env file into the sublime-platform directory

If you're in early access and don't have a sublime.env file, let us know on Slack.

mv ../path-to/sublime.env .

5. Start the Sublime Platform in the background:

docker-compose up -d

6. View your Dashboard and begin setup

Open your browser and visit the Dashboard at localhost:3000.

It may take a couple of minutes for all services to start for the first time, then you should see a welcome screen:

:tada: That's it! Click `Get started` to configure your first message source.:tada: That's it! Click `Get started` to configure your first message source.

:tada: That's it! Click Get started to configure your first message source.

Logs

You can view the system logs at any time by running: docker-compose logs -f.

Error logs are sent to Sentry so the Sublime team can troubleshoot issues and provide support for all early access users.

Telemetry

Basic information about your installation, including version and high-level usage information is shared with Sublime.

Sensitive data like your message content and metadata will never, ever be shared or accessible by Sublime or any other third party.

We value transparency. We collect telemetry for a few reasons:

  • To learn how the community is using the Platform so we can invest more time in certain features, and in general make product improvements.
  • To help us troubleshoot problems you run into. We're in early access, and not bug-free.
  • To notify you of bug fixes or vulnerabilities in the version you're running.

If any of this is an issue for you, if you have any questions or general feedback, or would like to disable telemetry, please let us know via email or Slack.

Deploying to a remote system

If you deploy this to a non-local system like a VPS, you'll need to modify CORS_ALLOW_ORIGINS and BASE_URL in your sublime.env file accordingly.

How to update

  1. Navigate to the directory where you cloned the sublime-platform Github repo

  2. Pull the latest docker-compose file from Github:

git pull
  1. Pull the latest images from Docker Hub and restart your instances:
docker-compose pull; docker-compose up -d