{"id":21848951,"url":"https://github.com/civilcode/maintenance","last_synced_at":"2026-04-22T05:31:18.836Z","repository":{"id":99410939,"uuid":"236756801","full_name":"civilcode/maintenance","owner":"civilcode","description":"Simple Docker container for hosting a maintenance page","archived":false,"fork":false,"pushed_at":"2020-01-29T21:17:39.000Z","size":60,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-30T00:04:37.738Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","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/civilcode.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":"2020-01-28T14:39:33.000Z","updated_at":"2020-01-29T21:17:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"20dc7048-ce48-4441-9208-98e42fe382e0","html_url":"https://github.com/civilcode/maintenance","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/civilcode/maintenance","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civilcode%2Fmaintenance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civilcode%2Fmaintenance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civilcode%2Fmaintenance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civilcode%2Fmaintenance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/civilcode","download_url":"https://codeload.github.com/civilcode/maintenance/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civilcode%2Fmaintenance/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32122679,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T00:31:26.853Z","status":"online","status_checked_at":"2026-04-22T02:00:05.693Z","response_time":58,"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":[],"created_at":"2024-11-28T00:09:41.255Z","updated_at":"2026-04-22T05:31:18.820Z","avatar_url":"https://github.com/civilcode.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Maintenance page\n\nThis is a Docker container that can be used to display a maintenance page. It is configured\nthrough environment variables in file `.env.maintenance`.\n\n- `TITLE`: the title to show on the page\n- `MESSAGE`: the message to show on the page\n- `MESSAGE_FILE`: if no message is provided, the content of the given message file (html) will be used. The container expects the file to be present in subfolder `maintenance` in the current folder.\n\n## Deployment\n\nThe deployment is done in two separate phases: `push` and `release`.\n\n    # On local machine\n    make deploy.push\n\n    # On target\n    make -f Makefile.maintenance deploy.release\n\n## Starting and stopping the maintenance page server\n\nUse the Makefile on the remote server to start, restart and stop the maintenance page server:\n\n    make -f Makefile.maintenance docker.run\n    make -f Makefile.maintenance docker.restart\n    make -f Makefile.maintenance docker.stop\n\n## Setup\n\n### 1. Retrieve the files on the server\n\nCopy files from local machine to the server that will host the maintenance page:\n\n    scp -P 22 Makefile {username}@{host}:~/Makefile.maintenance\n    scp -P 22 env.maintenance.sample {username}@{host}:~\n\n### 2. SSH into the remote server\n\nSee 1Password for details.\n\n### 3. Configure .env\n\n    cp env.maintenance.sample .env.maintenance\n    mkdir maintenance\n    chmod o+x maintenance\n\nConfigure the file for your application. The maintenance folder must have permission `x` set\nfor everyone (otherwise nginx will not be able to read from it).\n\n## Local testing\n\nTo test the maintenance page locally, you can run the container on your machine:\n\n    cp env.maintenance.sample .env.maintenance\n\nChange port to 8080 in file `.env.maintenance`\n\n    make docker.build\n    make docker.run\n    open http://localhost:8080\n    make docker.restart\n    make docker.stop\n\n# Future enhancements\n\n- [ ] Support SSL requests\n- [ ] Support multiple ports\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcivilcode%2Fmaintenance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcivilcode%2Fmaintenance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcivilcode%2Fmaintenance/lists"}