JetBrains SpaceCode Preview Help

Administration of SpaceCode On-Premises

There are several administration activities specific only to SpaceCode On-Premises:

  1. Uploading a SpaceCode product license.

  2. Enabling push notification for mobile clients.

Otherwise, in terms of administration, SpaceCode On-Premises is no different from its cloud version – refer to https://www.jetbrains.com/help/space/administrator-s-guide.html for basic administration instructions.

Activate your SpaceCode On-Premises instance

  1. In a browser, open your clean SpaceCode On-Premises installation. In case of a Docker Compose installation, the default URL is http://127.0.0.1:8084.

  2. Under the License field, click the link to log in to your JetBrains Account.

  3. On your account page, copy the license string and return back to SpaceCode.

  4. Paste the string to the License field.

  5. Fill other fields if required and click Get started.

Enable push notifications for mobile clients

SpaceCode provides mobile clients for iOS and Android. To send push notifications to mobile clients, your SpaceCode On-Premises instance must use a proxy server from JetBrains. The proxy server delivers the notifications to end users through the corresponding Apple and Google services.

To enable the proxy server for push notifications

  1. Make sure your SpaceCode instance has access to https://on-premises.service.jetbrains.space.

  2. On the top right, click your avatar and choose Administration.

  3. On the left sidebar menu. choose Notifications Proxy.

  4. Choose JetBrains Proxy and click Save.

Configure mail server

SpaceCode On-Premises comes without a mail server. This means that, by default, SpaceCode won't be able to send emails like user invitations, chat notifications, and so on.

To enable SpaceCode email notifications, you must create a mail server on your own and provide its settings to SpaceCode. Typically, you can provide the settings either during the installation or later, in the SpaceCode administration UI. For the Docker Compose installation in AWS, the SpaceCode UI is the only option.

Note that the mail server settings specified in the SpaceCode UI override the settings specified during the installation.

  1. On the top right, click your avatar and choose Administration.

  2. On the left sidebar menu. choose SMTP Settings.

  3. Specify the mail server settings:

    • Encryption: the encryption type supported by your mail server (STARTTLS, SSL/TLS, or None).

    • Host and Port: the host name and the port number of your mail server.

    • Username and Password: the credentials to access your mail server.

    • Email "From" address: the email address that will be used as the sender address for SpaceCode notifications.

  4. Click Save.

Last modified: 31 May 2024