{"id":20400034,"url":"https://github.com/kitware/cdash-docker","last_synced_at":"2025-04-12T13:50:49.779Z","repository":{"id":137029461,"uuid":"131364828","full_name":"Kitware/cdash-docker","owner":"Kitware","description":null,"archived":false,"fork":false,"pushed_at":"2019-02-28T13:25:56.000Z","size":12,"stargazers_count":15,"open_issues_count":5,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T08:23:24.632Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kitware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2018-04-28T02:35:51.000Z","updated_at":"2022-05-22T07:15:16.000Z","dependencies_parsed_at":"2023-06-05T06:00:42.856Z","dependency_job_id":null,"html_url":"https://github.com/Kitware/cdash-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fcdash-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fcdash-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fcdash-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fcdash-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kitware","download_url":"https://codeload.github.com/Kitware/cdash-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248575581,"owners_count":21127211,"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-15T04:36:14.692Z","updated_at":"2025-04-12T13:50:49.774Z","avatar_url":"https://github.com/Kitware.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cdash-docker\nDeploy a cdash instance with docker and zero guess work!\n\n## How?\n\nBuild with docker:\n\n```bash\ndocker build -t \"kitware/cdash-docker\" .\n```\n\n...or build with docker-compose\n\n```bash\ndocker-compose build\n```\n\n## Deploy example application using docker-compose\n\nSee `docker-compose.yml` for an example of how to deploy using the\n`cdash-docker` image.  Add your own customizations, or deploy the example as-is!\n\n```bash\ndocker-compose up -d\n```\n\nCheck on your instance's status:\n\n```bash\ndocker-compose ps\n```\n\nOnce docker reports that cdash is \"healthy\", you're good to go!  Browse your\ncdash instance at `localhost:8080`.\n\n## Container Variables\n\n### `CDASH_CONFIG`\n\nThe contents, verbatim, to be included in the local CDash configuration file\n(`/var/www/cdash/config/config.local.php`), excluding the initial `\u003c?php` line.\nWhen running the container on the command line, consider writing the contents to\na local file:\n\n```bash\n$EDITOR local-configuration.php\n...\ndocker run \\\n    -e CDASH_CONFIG=\"$( cat local-configuration.php )\" \\\n    ... \\\n    kitware/cdash-docker\n```\n\nNote: When setting this variable in a docker-compose file, take care to ensure\nthat dollar signs (`$`) are properly escaped.  Otherwise, the resulting contents\nof the file may be subject to variable interpolation.\n\nExample:\n\n```YAML\n\n...\n\n  # wrong: this string syntax is subject to interpolation\n  # The contents will depend on the CDASH_DB_... variables as they are set at\n  # container creation time\n  CDASH_CONFIG: |\n    $CDASH_DB_HOST = 'mysql';\n    $CDASH_DB_NAME = 'cdash';\n    $CDASH_DB_TYPE = 'mysql';\n    ...\n\n  # correct: use $$ to represent a literal `$`\n  CDASH_CONFIG: |\n    $$CDASH_DB_HOST = 'mysql';\n    $$CDASH_DB_NAME = 'cdash';\n    $$CDASH_DB_TYPE = 'mysql';\n    ...\n\n...\n```\n\n### `CDASH_ROOT_ADMIN_PASS`\n\nThe password for the \"root\" administrator user, or the initial administrator\nuser that is created during the CDash `install.php` procedure.  This is the only\nvariable that is strictly required.\n\nThe initial \"root\" administrator user is managed by the container.  The\ncontainer uses this user account to log in and provision the service as well as\nset up static users.  This account is not meant to be used by an actual\nadministrator.  To set up a predefined administrator account, see\n`CDASH_STATIC_USERS`.\n\n### `CDASH_ROOT_ADMIN_NEW_PASS`\n\nSet this variable to change the password for the root administrator account.  If\nset, the container will attempt to use this password when logging in as the root\naccount.  If the login is unsuccessful, it will try logging in using the\n(presumably former) password set in `CDASH_ROOT_ADMIN_PASS`.  If this second\nattempt is successful, it will update the root account so that its password is\nreset to the value of `CDASH_ROOT_ADMIN_NEW_PASS`.\n\n### `CDASH_STATIC_USERS`\n\nA multiline value representing the set of user accounts to prepare as part of\nthe container's initialization process.  This value may contain comments that\nstart with `#` and lines with only white space; these parts of the text are\nignored.\n\nEach user account identified in the set is created using the information\nprovided.  If the account already exists, its details are modified to match the\ninformation provided.  Existing accounts that are not identified in the set are\nnot modified.\n\nThe representation for each user account begins with a line of the following\nform:\n\n```\n[USER|ADMIN|DELETE] EMAIL PASSWORD [NEW_PASSWORD]\n```\n\nWhere `EMAIL` is the user's email address, `PASSWORD` is the user's password,\nand `NEW_PASSWORD` (if provided) is the user's new password.  If `NEW_PASSWORD`\nis provided, the user's password is updated using the same procedure as that\nwith `CDASH_ROOT_ADMIN_NEW_PASS`.\n\nThis entry line may begin with an additional token.  A token of `USER` indicates\nthat the entry is for a normal (non-admin) account.  A token of `ADMIN`\nindicates that the entry is for an administrator account.  A token of `DELETE`\nindicates that any account with the given email (if found) should be deleted.\nIf no such token is provided, `USER` is assumed by default.\n\nAn entry may include an additional, optional line.  Such lines must be of the\nfollowing form:\n\n```\n[INFO] FIRST_NAME [LAST_NAME] [INSTITUTION]\n```\n\nWhere `FIRST_NAME` is the user's first name, `LAST_NAME` is the user's last\nname, and `INSTITUTION` is the name of the institution with which the user is\naffiliated.\n\nThis second line may begin with an additional token with the value `INFO`, which\nmay be provided to distinguish this second line from a line representing a new\nuser account, in case the user's first name contains an `@` character.  For such\nunusual cases, include this token so that the name is not mistaken for an email\naddress.\n\nNote: for `DELETE` entries, all that is needed is the account's email address,\nand for either `PASSWORD` or `NEW_PASSWORD` (if provided) to be set to the\npassword needed to log in as that user.  You may provide additional information\nfor the account, but it will not be used since the account will be deleted.\n\nNote: for tokens with spaces, wrap them in quotes (`\"`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Fcdash-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitware%2Fcdash-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Fcdash-docker/lists"}