{"id":18400486,"url":"https://github.com/docksal/play-with-docksal","last_synced_at":"2025-04-12T16:57:19.508Z","repository":{"id":73903436,"uuid":"178300484","full_name":"docksal/play-with-docksal","owner":"docksal","description":"Play with Docksal","archived":false,"fork":false,"pushed_at":"2019-11-15T10:21:41.000Z","size":401,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2024-04-13T21:54:55.087Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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,"governance":null},"funding":{"github":"docksal","open_collective":"docksal"}},"created_at":"2019-03-29T00:03:59.000Z","updated_at":"2019-11-15T10:21:39.000Z","dependencies_parsed_at":"2023-02-24T21:30:28.693Z","dependency_job_id":null,"html_url":"https://github.com/docksal/play-with-docksal","commit_stats":{"total_commits":20,"total_committers":2,"mean_commits":10.0,"dds":"0.19999999999999996","last_synced_commit":"2a1a1f5ec995fe0c148c9d0cd64a644f8fa91470"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fplay-with-docksal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fplay-with-docksal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fplay-with-docksal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docksal%2Fplay-with-docksal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docksal","download_url":"https://codeload.github.com/docksal/play-with-docksal/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247953841,"owners_count":21024099,"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:33:44.310Z","updated_at":"2025-04-12T16:57:19.490Z","avatar_url":"https://github.com/docksal.png","language":"Go","funding_links":["https://github.com/sponsors/docksal","https://opencollective.com/docksal"],"categories":[],"sub_categories":[],"readme":"# Play with Docksal - AWS CloudFormation\n\nThis is a Play with Docksal template for AWS CloudFormation.\n\nAWS CloudFormation is a service that helps you model and set up your Amazon Web Services resources so that you\ncan spend less time managing those resources and more time focusing on your applications that run in AWS.\nYou create a template that describes all the AWS resources that you want (like Amazon EC2 instances or Amazon RDS\nDB instances), and AWS CloudFormation takes care of provisioning and configuring those resources for you. You\ndon't need to individually create and configure AWS resources and figure out what's dependent on what;\nAWS CloudFormation handles all of that. \n\nFor an overview of AWS CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html.)\n\n## Quick setup (using CloudFormation web UI)\n\nIf you have an existing AWS account (with billing and an SSH key pair), just click on the button below!\n\n[![Launch Stack](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://console.aws.amazon.com/cloudformation/home#/stacks/new?stackName=play-with-docksal\u0026templateURL=https://s3.us-east-2.amazonaws.com/docksal-aws-templates/play-with-docksal/edge/template.yaml)\n\nYou will be prompted for:\n\n- Instance type\n- SSH key name\n\nOnce provisioned, the IP address of the server will be printed in the **Outputs** section in CloudFormation (`\u003cexternal-ip\u003e`). \n\nNote: You will need the key you selected to access the Play with Docksal server in further steps (`\u003cssh-private-key\u003e`).\n\nYou can now proceed to [Access the Play with Docksal server](/README.md#server-access) \n\nNote: For manual setup steps (using console tools), see [Manual setup](#manual)\n\n\n\u003ca name=\"manual\"\u003e\u003c/a\u003e\n## Manual setup (using console tools)\n\nStep-by-step manual setup instructions using aws cli and provisioning scripts. \n\n### Initial setup on AWS\n\n1. Log in or create a new AWS account.\n\n1. [Create Access Keys for Your AWS Account Root User](https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html). Keep these keys in a safe place!\n\n1. [Create SSH key pair or import existing key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair).\n \n    **Note**: You can also use the `ssh-key-create` / `ssh-key-import` scripts in this repo (see instructions below).\n\n1. Install `aws` cli tool locally (for Ubuntu run `sudo apt install awscli`)\n\n1. Clone this repo\n\n1. Configure `aws` cli tool to use your account\n\n    ```\n    aws configure\n    ```\n\n### Create SSH key pair and import the key to AWS EC2\n\n**Note**: Skip this step, if you already have an existing SSH key pair or created one earlier in this process.\n\nNavigate to the `aws-cloudformation` folder:\n\n    cd aws-cloudformation\n\nExecute:\n\n    ./scripts/ssh-key-create \u003ckeyname\u003e - this will create new SSH key pair in your ~/.ssh directory\n    ./scripts/ssh-key-import \u003ckeyname\u003e - this will import a local SSH key pair to all AWS EC2 regions\n\n### Deploy the Play with Docksal server\n\nNavigate to the `aws-cloudformation` folder:\n\n    cd aws-cloudformation\n\nCreate template ready for deploy:\n\n    ./scripts/bash2yaml startup.sh - will create template file template.yaml with startup.sh merged in it\n    ./scripts/bash2json startup.sh - will create template file template.json with startup.sh merged in it\n\nBy default create-stack script uses `template.yaml`. If you want using template in json format you can edit\n`create-stack` script and change the value of the `template_file` variable to the preferred template format.\n\nLaunch the deployment:\n\n    ./create-stack \u003cstack-name\u003e \u003ckeyname\u003e [\u003cinstancetype\u003e]\n\nIn the output of the command you'll find the server public IP address:\n\n    InstanceIPAddress \u003cexternal-ip\u003e\n\nYou can now proceed to [Access the Play with Docksal server](/README.md#server-access)\n\n### Delete the Play with Docksal server\n\nTo delete the deployment and all the resources that were created:\n\n    ./delete-stack \u003cstack-name\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocksal%2Fplay-with-docksal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocksal%2Fplay-with-docksal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocksal%2Fplay-with-docksal/lists"}