https://github.com/docksal/sandbox-server
Docksal Sandbox Server templates
https://github.com/docksal/sandbox-server
Last synced: about 1 year ago
JSON representation
Docksal Sandbox Server templates
- Host: GitHub
- URL: https://github.com/docksal/sandbox-server
- Owner: docksal
- License: mit
- Created: 2018-08-24T14:19:56.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-27T10:57:32.000Z (over 3 years ago)
- Last Synced: 2025-04-11T06:01:41.870Z (about 1 year ago)
- Language: Shell
- Size: 160 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docksal Sandbox Server
Turn-key templates to launch a Docksal Sandbox Server in the cloud.
## Launch a sandbox server
Follow the instructions for supported cloud providers:
- [Amazon Web Services](./aws-cloudformation)
- [Google Cloud Platform](./gcp-deployment-manager)
When done, come back and continue reading.
SSH into the server as the `build-agent` user:
ssh -i build-agent@
**Note**: `` and `` are values from the server provisioning step.
Docksal is installed under the `build-agent` user account on the server. Sandbox builds MUST run as this user.
Sandbox builds path: `/home/build-agent/builds`
Sandbox build URLs:
http://..nip.io
https://..nip.io
## Launch a sample sandbox
As the `build-agent` user on the server:
cd ~/builds
fin project create
Follow the project wizard instructions.
You will get an "internal" URL for the sandbox in the end. Add the `.nip.io` prefix to it to access it
externally, e.g.:
http://myproject.docksal => http://myproject.docksal..nip.io
## Set up the CI connection
The sandbox server is controlled over SSH by a `ci-agent` (`docksal/ci-agent`) container, which runs your CI builds.
CI => docksal/ci-agent container => SSH => Docksal Sandbox Server
Set the following variables in your CI project/organization build settings to tell `ci-agent` how to access
the provisioned sandbox server:
- `DOCKSAL_HOST_IP` - the external IP of the sandbox server obtained in the previous steps (``).
- `DOCKSAL_HOST_SSH_KEY` - copy it from the output of `cat | base64`
**Note**: `` and `` are values from the server provisioning step.
For more information on `ci-agent` configuration see https://github.com/docksal/ci-agent
### Advanced CI build settings
See [Project configuration](https://github.com/docksal/ci-agent#project-configuration) docs for more details on
`docksal/ci-agent` configuration options.