Configure Space for Docker Compose Production Environment

Open the {space_install_dir/config} directory (e.g., space-on-premises/config) and run:

docker cp {space_container_id}:/home/space/circlet-server-onprem/config .

note

Your Space On-Premises instance must be running.

The following configuration files will be copied to the {space_install_dir/config} directory on the host machine:

• langservice.on-premises.conf

• packages.on-premises.conf

• space.on-premises.conf

• vcs.on-premises.properties

Edit the configuration files according to your needs.

Stop your Space instance:

docker-compose -p space-on-premises down
docker-compose -p space-on-premises rm -f

Open the docker-compose.yml file located in the Space installation directory.

Change the default location of the Space configuration files. To do this, edit the docker-compose.yml file:

1. Comment out the config:{} line:

   ...
   # config:{}
   ...

2. Change every reference to the docker volume configuration from config to ./config. Namely, from:

   ...
   volumes:
   - config:/home/init-config/config
   ...
   volumes:
   - config:/home/space/circlet-server-onprem/config
   ...
   volumes:
   - config:/home/space/git/vcs-hosting/config
   ...
   volumes:
   - config:/home/space/packages-server/config
   ...
   volumes:
   - config:/home/space/langservice-server/config
   ...

   to:

   ...
   volumes:
   - ./config:/home/init-config/config
   ...
   volumes:
   - ./config:/home/space/circlet-server-onprem/config
   ...
   volumes:
   - ./config:/home/space/git/vcs-hosting/config
   ...
   volumes:
   - ./config:/home/space/packages-server/config
   ...
   volumes:
   - ./config:/home/space/langservice-server/config
   ...

Start Space On-Premises with the updated configuration:

docker-compose -p space-on-premises up -d

On the host machine, create the space.conf NGINX configuration file in the /etc/nginx/conf.d directory. For example:

server {
 {...}

In the example above, change:

• All ssl_certificate and ssl_certificate_key paths to the real paths to your certificates.

• All server_name values (space.example.com, git.example.com, and packages.example.com) to the real domain names.

Save the changes and apply the configuration:

sudo nginx -s reload

Make your Space instance available for customization.

Stop your Space instance if it is running.

Open the Space installation directory.

In the space.on-premises.conf file, update all url and altUrls parameters with new URL values. For example:

circlet {
    frontend {
        url = "https://space.example.com"
        internalUrl = "http://space:9084"
    }
    packages {
        notifications {
            enabled = true
        }
        types {
            maven {
                url = "https://packages.example.com"
            }

            nuget {
                url = "https://packages.example.com"
            }

            npm {
                url = "https://packages.example.com"
            }

            container {
                url = "https://packages.example.com"
            }

            pypi {
                url = "https://packages.example.com"
            }

            composer {
                url = "https://packages.example.com"
            }

            dart {
                url = "https://packages.example.com"
            }

            files {
                url = "https://packages.example.com"
            }

            crates {
                url = "https://packages.example.com"
            }
        }
    }
}

In the packages.on-premises.conf file, update all url and internalUrl parameters with new URL values. For example:

circlet {
    packages {
        url = "https://packages.example.com"
        internalUrl = "http://packages:9390"
    }

    space {
        url = "https://space.example.com"
        internalUrl = "http://space:9084"
    }

    storage {
        aws {
            publicUrl = "https://minio.example.com"
        }
    }
}

In the vcs.on-premises.properties file, update teh base.url and circlet.url.ext parameters with new URL values. For example:

base.url=https://git.example.com
circlet.url.int=http://space:9084
circlet.url.ext=https://space.example.com

Start Space On-Premises with the updated configuration:

docker-compose up -d

Stop your Space instance if it is running.

Open the Space installation directory.

In the docker-compose.yml file, add the mail server configuration:

services:
  mailhog:
    image: mailhog/mailhog
    ports:
    - 1025:1025 # SMTP server port
    - 8025:8025 # UI port
    networks:
    - "frontend"

Provide the mail server settings to Space. You can do this in two different ways: using the Space administration UI or using the Space configuration file.

Sign in to the AWS Management Console and open the Amazon S3 console.

Open the S3 bucket used for Space Packages.

Open the Permissions tab and add the following configuration to the CORS section:

[
    {
        "AllowedHeaders": [
            "*"
        ],
        "AllowedMethods": [
            "GET"
        ],
        "AllowedOrigins": [
            "*"
        ],
        "ExposeHeaders": []
    }
]

Save the changes.