{"id":29859275,"url":"https://github.com/gocd/docker-gocd-server","last_synced_at":"2025-07-30T02:12:42.845Z","repository":{"id":55752392,"uuid":"83538449","full_name":"gocd/docker-gocd-server","owner":"gocd","description":"Docker server image for GoCD","archived":false,"fork":false,"pushed_at":"2025-01-26T17:22:27.000Z","size":145,"stargazers_count":99,"open_issues_count":0,"forks_count":79,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-01-26T18:26:40.563Z","etag":null,"topics":["docker-container","docker-image","gocd","gocd-server"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/gocd/gocd-server/","language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gocd.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-01T09:46:01.000Z","updated_at":"2025-01-26T17:22:31.000Z","dependencies_parsed_at":"2023-01-22T02:45:20.772Z","dependency_job_id":"903fb4b7-dd4a-4f8e-9a18-9aaa721b51a5","html_url":"https://github.com/gocd/docker-gocd-server","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"purl":"pkg:github/gocd/docker-gocd-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocd%2Fdocker-gocd-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocd%2Fdocker-gocd-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocd%2Fdocker-gocd-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocd%2Fdocker-gocd-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gocd","download_url":"https://codeload.github.com/gocd/docker-gocd-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gocd%2Fdocker-gocd-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267797709,"owners_count":24145710,"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","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker-container","docker-image","gocd","gocd-server"],"created_at":"2025-07-30T02:12:42.306Z","updated_at":"2025-07-30T02:12:42.822Z","avatar_url":"https://github.com/gocd.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GoCD Server Container image\n\nA Wolfi-based container image for [GoCD server](https://www.gocd.org).\n\n# Issues, feedback?\n\nPlease make sure to log them at https://github.com/gocd/gocd.\n\n# Usage\n\nStart the container with this:\n\n```shell\ndocker run -d -p8153:8153 gocd/gocd-server:v25.2.0\n```\n\nThis will expose container port 8153 (http) onto your server.\nYou can now open `http://localhost:8153`\n\n# Available configuration options\n\n## Mounting volumes\n\nThe GoCD server will store all configuration, pipeline history database,\nartifacts, plugins, and logs into `/godata`. If you'd like to provide secure\ncredentials like SSH private keys among other things, you can mount `/home/go`\n\n```shell\ndocker run -v /path/to/godata:/godata -v /path/to/home-dir:/home/go gocd/gocd-server:v25.2.0\n```\n\n\u003e **Note:** Ensure that `/path/to/home-dir` and `/path/to/godata` is accessible by the `go` user in container (`go` user - uid `1000`).\n\n## Installing plugins\n\nAll plugins can be installed under `/godata`.\n\n### Installing plugins using an environment configuration\n\nTo install plugins, just add an ENV variable with the prefix `GOCD_PLUGIN_INSTALL_` and your name as `suffix`\nand the value being the download URL. The plugin will only be downloaded if not yet present.\n\nAn example example would be `GOCD_PLUGIN_INSTALL_docker-elastic-agents=https://github.com/gocd-contrib/docker-elastic-agents/releases/download/v0.8.0/docker-elastic-agents-0.8.0.jar`:\n\n```shell\ndocker run \\\n  -e GOCD_PLUGIN_INSTALL_docker-elastic-agents=https://github.com/gocd-contrib/docker-elastic-agents/releases/download/v0.8.0/docker-elastic-agents-0.8.0.jar \\\n  gocd/gocd-server:v25.2.0\n```\n\nTo install multiple plugins, add several `-e` arguments as such:\n\n```shell\ndocker run \\\n  -e GOCD_PLUGIN_INSTALL_a-plugin=https://example.com/a-plugin.jar \\\n  -e GOCD_PLUGIN_INSTALL_b-plugin=https://example.com/b-plugin.jar \\\n  gocd/gocd-server:v25.2.0\n```\n\n### Installing plugins using a custom entry-point script (see below)\n\n```shell\nmkdir -p /godata/plugins/external\ncurl --location --fail https://example.com/plugin.jar \u003e /path/to/godata/plugins/external/plugin.jar\nchown -R 1000 /godata/plugins/external\n```\n\n## Loading configuration from existing git repo\nTo load existing configuration from git repo, just add an ENV variable `CONFIG_GIT_REPO`.\nAuth token may be used to access private repo. Branch `master` would be cloned by default.\nTo load another branch, define an ENV variable `CONFIG_GIT_BRANCH`.\nIf `/godata/config` already is git repo then CONFIG_GIT_REPO will be ignored.\nCloned repo **must** contain all files from `/godata/config` dir.\n\n```shell\ndocker run \\\n  -e CONFIG_GIT_REPO=https://gocd_user:\u003cpassword_or_auth_token\u003e/config.git \\\n  -e CONFIG_GIT_BRANCH=branch_with_config \\\n  gocd/gocd-server:v25.2.0\n```\n*Checkouted content would overwrite files in `/godata/config/`*.\n\n\n## Running custom entrypoint scripts\n\nTo execute custom script(s) during the container boostrap, but **before** the GoCD server starts just add `-v /path/to/your/script.sh:/docker-entrypoint.d/your-script.sh` like so:\n\n```shell\ndocker run -v /path/to/your/script.sh:/docker-entrypoint.d/your-script.sh ... gocd/gocd-server:v25.2.0\n```\n\nIf you have several scripts in a directory that you'd like to execute:\n\n```shell\ndocker run -v /path/to/script-dir:/docker-entrypoint.d ... gocd/gocd-server:v25.2.0\n```\n\n\u003e **Note:** Ensure that your scripts are executable `chmod a+x` — you can add as many scripts as you like, `bash` is available on the container. If your script uses other scripting language (perl, python), please ensure that the scripting language is installed in the container.\n\n## Tweaking JVM options (memory, heap etc)\n\nJVM options can be tweaked using the environment variable `GOCD_SERVER_JVM_OPTS`.\n\n```shell\ndocker run -e GOCD_SERVER_JVM_OPTS=\"-Xmx4096mb -Dfoo=bar\" gocd/gocd-server:v25.2.0\n```\n\n# Under the hood\n\nThe GoCD server runs as the `go` user, the location of the various directories is:\n\n| Directory           | Description                                                                      |\n|---------------------|----------------------------------------------------------------------------------|\n| `/godata/artifacts` | the directory where GoCD artifacts are stored                                    |\n| `/godata/config`    | the directory where the GoCD configuration is stored                             |\n| `/godata/db`        | the directory where the GoCD database and configuration change history is stored |\n| `/godata/logs`      | the directory where GoCD logs will be written out to                             |\n| `/godata/plugins`   | the directory containing GoCD plugins                                            |\n| `/home/go`          | the home directory for the GoCD server                                           |\n\n# Determine Server IP and Ports on Host\n\nOnce the GoCD server is up, we should be able to determine its ip address and the ports mapped onto the host by doing the following:\nThe IP address and ports of the GoCD server in a docker container are important to know as they will be used by the GoCD agents to connect to it.\nIf you have started the container with\n```shell\ndocker run --name server -it -p8153:8153 gocd/gocd-server:v25.2.0\n```\n\nThen, the below commands will determine to GoCD server IP, server port and ssl port\n```shell\ndocker inspect --format='{{(index (index .NetworkSettings.IPAddress))}}' server\ndocker inspect --format='{{(index (index .NetworkSettings.Ports \"8153/tcp\") 0).HostPort}}' server\n```\n\n# Troubleshooting\n\n## The GoCD server does not come up\n\n- Check if the docker container is running `docker ps -a`\n- Check the STDOUT to see if there is any output that indicates failures `docker logs CONTAINER_ID`\n- Check the server logs `docker exec -it CONTAINER_ID tail -f /godata/logs/go-server.log` (or check the log file in the volume mount, if you're using one)\n\n\n# License\n\n```plain\nCopyright Thoughtworks, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n[0]: https://www.gocd.org/download/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocd%2Fdocker-gocd-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgocd%2Fdocker-gocd-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgocd%2Fdocker-gocd-server/lists"}