{"id":20723245,"url":"https://github.com/microserve-io/puppet-docksal","last_synced_at":"2025-04-23T17:24:04.183Z","repository":{"id":57664621,"uuid":"171711807","full_name":"microserve-io/puppet-docksal","owner":"microserve-io","description":"Deploy and configure the Docksal development environment.","archived":false,"fork":false,"pushed_at":"2020-04-01T10:12:42.000Z","size":69,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T18:03:39.028Z","etag":null,"topics":["development-environment","development-tools","drupal","puppet","puppet-module"],"latest_commit_sha":null,"homepage":"https://microserve.io","language":"Ruby","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/microserve-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-02-20T16:45:39.000Z","updated_at":"2020-04-01T10:11:35.000Z","dependencies_parsed_at":"2022-09-11T05:01:44.385Z","dependency_job_id":null,"html_url":"https://github.com/microserve-io/puppet-docksal","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microserve-io%2Fpuppet-docksal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microserve-io%2Fpuppet-docksal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microserve-io%2Fpuppet-docksal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microserve-io%2Fpuppet-docksal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microserve-io","download_url":"https://codeload.github.com/microserve-io/puppet-docksal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250343956,"owners_count":21415041,"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":["development-environment","development-tools","drupal","puppet","puppet-module"],"created_at":"2024-11-17T04:08:03.398Z","updated_at":"2025-04-23T17:24:04.153Z","avatar_url":"https://github.com/microserve-io.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/microserve-io/puppet-docksal.svg?branch=master)](https://travis-ci.org/microserve-io/puppet-docksal)\n\n# docksal\n#### Table of Contents\n\n1. [Description](#description)\n2. [Setup - The basics of getting started with docksal](#setup)\n    * [What docksal affects](#what-docksal-affects)\n    * [Setup requirements](#setup-requirements)\n    * [Beginning with docksal](#beginning-with-docksal)\n3. [Usage - Configuration options and additional functionality](#usage)\n4. [Limitations - OS compatibility, etc.](#limitations)\n5. [Development - Guide for contributing to the module](#development)\n\n## Description\n\nInstalls and configures the docksal (github.com/docksal/docksal) program both for use by individual developers and in the 'CI' configuration. Does not manage configurations.\n\n## Setup\n\n### What docksal affects\n\nInstalls the fin cli to /usr/local/fin so that any user can execute it. Also creates user-specific config files in \u003chome\u003e/.docksal/docksal.env and assumes full control over that file.\n\n### Setup Requirements\n\nRequires docker installed. For Mac requires docker installed either natively, or virtualbox installed.\n\n### Beginning with docksal\n\nInstalling docksal globally is as simple as `include docksal`. Doing this will *not* affect individual user configuration files.\n\n## Usage\n\n### Install and configure docksal for the user `demo`\n\nInstall docksal globally and take control over the demo user's configuration file. This will control the file `/home/demo/.docksal/docksal.env` and install the default configuration options.\n\n```puppet\ninclude docksal\n\ndocksal::config { 'demo': }\n```\n\n### Install and configure docksal for a non-default home path\n\nAlthough we assume that the home path of the user is `/home/\u003cusername\u003e`, this is not applicable to mac nor to all users. If you need to override this value, it is as simple as:\n\n```puppet\ninclude docksal\n\ndocksal::config { 'root':\n  home_directory =\u003e '/root'\n}\n```\n\n### Install and configure with the CI variable set\n\nDocksal CI mode is useful when you want to have CI server managed development environments. You can create the config for that by using:\n\n```puppet\ninclude docksal\n\ndocksal::config { 'ci_user':\n  home_directory =\u003e '/var/ci_runner',\n  ci =\u003e true\n}\n```\n\n### Adding custom environment variables\n\nTo add custom environment variables to the `docksal.env` files managed by puppet, you can pass in the `env` parameter. For example:\n\n```puppet\ninclude docksal\n\ndocksal::config { 'ci_user':\n  home_directory =\u003e '/var/ci_runner',\n  env =\u003e {\n    HOSTING_ENVIRONMENT =\u003e 'qa'\n  }\n}\n```\n\n## Limitations\n* User home directory default doesn't ever work for macos\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroserve-io%2Fpuppet-docksal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicroserve-io%2Fpuppet-docksal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroserve-io%2Fpuppet-docksal/lists"}