{"id":18400516,"url":"https://github.com/docksal/sandbox-server","last_synced_at":"2025-04-12T16:57:23.350Z","repository":{"id":42512013,"uuid":"146000708","full_name":"docksal/sandbox-server","owner":"docksal","description":"Docksal Sandbox Server templates","archived":false,"fork":false,"pushed_at":"2023-01-27T10:57:32.000Z","size":164,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-11T06:01:41.870Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docksal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-24T14:19:56.000Z","updated_at":"2023-01-27T09:47:52.000Z","dependencies_parsed_at":"2023-02-15T08:17:04.983Z","dependency_job_id":null,"html_url":"https://github.com/docksal/sandbox-server","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fsandbox-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fsandbox-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fsandbox-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fsandbox-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docksal","download_url":"https://codeload.github.com/docksal/sandbox-server/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248601590,"owners_count":21131611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T02:34:09.454Z","updated_at":"2025-04-12T16:57:23.330Z","avatar_url":"https://github.com/docksal.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docksal Sandbox Server\n\nTurn-key templates to launch a Docksal Sandbox Server in the cloud.\n\n## Launch a sandbox server\n\nFollow the instructions for supported cloud providers:\n\n- [Amazon Web Services](./aws-cloudformation)\n- [Google Cloud Platform](./gcp-deployment-manager)\n\nWhen done, come back and continue reading.\n\n\u003ca name=\"server-access\"\u003e\u003c/a\u003e\n## Access the sandbox server\n\nSSH into the server as the `build-agent` user:\n\n    ssh -i \u003cssh-private-key\u003e build-agent@\u003cexternal-ip\u003e\n\n**Note**: `\u003cssh-private-key\u003e` and `\u003cexternal-ip\u003e` are values from the server provisioning step.\n\nDocksal is installed under the `build-agent` user account on the server. Sandbox builds MUST run as this user.\n\nSandbox builds path: `/home/build-agent/builds`\n\nSandbox build URLs:\n\n    http://\u003csandbox-vhost\u003e.\u003cexternal-ip\u003e.nip.io\n    https://\u003csandbox-vhost\u003e.\u003cexternal-ip\u003e.nip.io\n\n## Launch a sample sandbox\n\nAs the `build-agent` user on the server:\n\n    cd ~/builds\n    fin project create\n\nFollow the project wizard instructions.\n\nYou will get an \"internal\" URL for the sandbox in the end. Add the `\u003cexternal-ip\u003e.nip.io` prefix to it to access it \nexternally, e.g.:\n\n    http://myproject.docksal =\u003e http://myproject.docksal.\u003cexternal-ip\u003e.nip.io\n\n## Set up the CI connection\n\nThe sandbox server is controlled over SSH by a `ci-agent` (`docksal/ci-agent`) container, which runs your CI builds.\n\n    CI =\u003e docksal/ci-agent container =\u003e SSH =\u003e Docksal Sandbox Server\n\nSet the following variables in your CI project/organization build settings to tell `ci-agent` how to access \nthe provisioned sandbox server:\n\n- `DOCKSAL_HOST_IP` - the external IP of the sandbox server obtained in the previous steps (`\u003cexternal-ip\u003e`).\n- `DOCKSAL_HOST_SSH_KEY` - copy it from the output of `cat \u003cssh-private-key\u003e | base64`\n\n**Note**: `\u003cssh-private-key\u003e` and `\u003cexternal-ip\u003e` are values from the server provisioning step.\n\nFor more information on `ci-agent` configuration see https://github.com/docksal/ci-agent\n\n### Advanced CI build settings\n\nSee [Project configuration](https://github.com/docksal/ci-agent#project-configuration) docs for more details on \n`docksal/ci-agent` configuration options.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocksal%2Fsandbox-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocksal%2Fsandbox-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocksal%2Fsandbox-server/lists"}