{"id":17979449,"url":"https://github.com/pauldotknopf/gitlab-page-server","last_synced_at":"2026-03-09T14:06:34.459Z","repository":{"id":147675215,"uuid":"134484102","full_name":"pauldotknopf/gitlab-page-server","owner":"pauldotknopf","description":"A GitLab page server. Similar to the built-in page server, but with some additional features.","archived":false,"fork":false,"pushed_at":"2018-07-07T00:05:00.000Z","size":643,"stargazers_count":11,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-06T07:01:35.580Z","etag":null,"topics":["csharp","dotnet","gitlab","gitlab-webhook"],"latest_commit_sha":null,"homepage":"","language":"C#","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/pauldotknopf.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":"2018-05-22T22:50:10.000Z","updated_at":"2022-07-13T03:43:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"41dbfd7f-4f68-426f-a700-d7838fb358b8","html_url":"https://github.com/pauldotknopf/gitlab-page-server","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/pauldotknopf/gitlab-page-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pauldotknopf%2Fgitlab-page-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pauldotknopf%2Fgitlab-page-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pauldotknopf%2Fgitlab-page-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pauldotknopf%2Fgitlab-page-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pauldotknopf","download_url":"https://codeload.github.com/pauldotknopf/gitlab-page-server/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pauldotknopf%2Fgitlab-page-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30297921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T13:46:43.843Z","status":"ssl_error","status_checked_at":"2026-03-09T13:46:42.821Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["csharp","dotnet","gitlab","gitlab-webhook"],"created_at":"2024-10-29T17:37:42.325Z","updated_at":"2026-03-09T14:06:34.450Z","avatar_url":"https://github.com/pauldotknopf.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gitlab-page-server\n\nA GitLab page server. Similar to the built-in page server, but with some additional features.\n\n[![Build Status](https://travis-ci.com/pauldotknopf/gitlab-page-server.svg?branch=develop)](https://travis-ci.com/pauldotknopf/gitlab-page-server)\n\n## Details\n\n\n\n## Installation\n\n1. Run the server. Example `docker-compose.yml` file [here](build/docker/example/docker-compose.yml). Configurable options [here](#more-options).\n   * At a bare minimum, you should have the following configured for things to work properly.\n   ```\n   {\n     \"Pages\": {\n       \"ServerUrl\": \"http://192.168.0.6\",\n       \"AuthToken\": \"AdNAuSLZxGvU1cHycNxU\"\n     }\n   }\n   ```\n   This configuration should go in a `config.json` file in the working directory of the running server.\n2. On GitLab under `Project \u003e Settings \u003e Integrations`, add a web hook that points to `https://your-page-server-instance.com/hook` and tick the following:\n   * [x] Job events\n   * [x] Pipeline events\n\nThat's it. Visit `your-domain.com/group/project` to serve your static pages.\n\n## Endpoints\n\n* `your-domain.com/` - Serves content from your configured `\"RootProject\"`.\n* `your-domain.com/project/group/` - Serve content from default branch/job for the repository.\n* `your-domain.com/project/group/-/pipeline/1/` - Serve content from a specific pipeline. This is great for generating previews for merge requests.\n* `your-domain.com/project/group/-/job/1/` - Serve content from a single job, typically your `\"BuildJobName\"`, which is `pages` by default.\n\n## More options\n\n### Logging\n\n**Defaults**:\n\n```\n{\n  \"Logging\": {\n    \"MinimumLevel\": \"Information\"\n  }\n}\n```\n\n### Pages\n\n**Defaults**:\n\n```\n{\n  \"Pages\": {\n    \"ServerUrl\": null,\n    \"AuthToken\": null,\n    \"HookToken\": null,\n    \"AdditionalParentGroups\": 0,\n    \"ArtifactsCacheDirectory\": \"artifacts\",\n    \"JobArtifactsBasePath\": \"public\",\n    \"RepositoryBranch\": \"master\",\n    \"BuildJobName\": \"pages\",\n    \"RootProject\": null,\n    \"CacheProjectType\": \"Sliding\",\n    \"CacheProjectSeconds\": 60,\n    \"CachePipelineType\": \"Sliding\",\n    \"CachePipelineSeconds\": 60,\n    \"CacheJobType\": \"Sliding\",\n    \"CacheJobSeconds\": 60\n  }\n}\n```\n\n**Details**:\n\n* `\"ServerUrl\"`: You can point this to ```gitlab.com``` or your own hosted GitLab instance.\n* `\"AuthToken\"`: Generate this from your account settings.\n* `\"HookToken\"`: The secret token, configured in GitLab, for the web hook. This ensures that only GitLab can post to your hook.\n* `\"AdditionalParentGroups\"`: By default, all requests will attempt to match one parent group. Add more using this property. This allows you to have deep pages (`your-domain.com/parent-group/sub-group/another-sub-group/project`).\n* `\"ArtifactsCacheDirectory\"`: The location where the artifacts will be cached on disk. This path is relative to the working directory.\n* `\"JobArtifactsBasePath\"`: The directory within the download artifacts that content will be served from.\n* `\"RepositoryBranch\"`: The branch that the url `your-domain.com/group/project` will serve from.\n* `\"BuildJobName\"`: The name of the job that artifacts will be downloaded from, within a pipeline.\n* `\"RootProject\"`: The project that will be served when visiting `your-domain.com/`. This is great for giving your domain a landing page at the root.\n* `\"Cache*\"`: Various knobs for tuning caching. You likely won't need to change this. The web hooks will invalidate the cache when new artifacts are available.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpauldotknopf%2Fgitlab-page-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpauldotknopf%2Fgitlab-page-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpauldotknopf%2Fgitlab-page-server/lists"}