{"id":13559144,"url":"https://github.com/Tellios/staticless","last_synced_at":"2025-04-03T14:31:19.756Z","repository":{"id":93140563,"uuid":"105437054","full_name":"Tellios/staticless","owner":"Tellios","description":"Simplified flow for viewing markdown wikis in GitLab similar to GitLab pages but without the need to generate static web pages","archived":false,"fork":false,"pushed_at":"2018-10-26T15:33:00.000Z","size":355,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-04T10:43:50.619Z","etag":null,"topics":["gitlab","wiki"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/Tellios.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-10-01T11:19:59.000Z","updated_at":"2018-10-26T15:22:23.000Z","dependencies_parsed_at":"2023-03-06T13:00:41.879Z","dependency_job_id":null,"html_url":"https://github.com/Tellios/staticless","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/Tellios%2Fstaticless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tellios%2Fstaticless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tellios%2Fstaticless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tellios%2Fstaticless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tellios","download_url":"https://codeload.github.com/Tellios/staticless/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247018431,"owners_count":20870003,"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":["gitlab","wiki"],"created_at":"2024-08-01T12:05:22.512Z","updated_at":"2025-04-03T14:31:19.739Z","avatar_url":"https://github.com/Tellios.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","others"],"sub_categories":[],"readme":"# Staticless\nThe goal of Staticless is to provide a simplified flow for viewing markdown wikis in GitLab similar to GitLab pages but without the need to generate static web pages using builds combined with deploys. Instead Staticless relies on the GitLab API to retrieve pages.\n\nThe required [GitLab API](https://docs.gitlab.com/ce/api/wikis.html) was added in GitLab 10.0, Staticless will therefore not work with versions before GitLab 10.0.\n\n**Disclaimer: Staticless is still under development. In its current state bugs, issues, and sudden changes may occur.**\n\n## Running Staticless\nFor now the only supported way of using Staticless is by using the provided [Docker container](https://store.docker.com/community/images/tellios/staticless). More ways may be added and documented in the future.\n\n### Configuring Staticless\nConfigurations can be applied using configuration files using the following paths:\n\n1. Working directory `staticless.json` file\n2. `Application directory/config/staticless.json` file\n\n#### Configuration properties\n\nAn example of this is the JSON configuration here:\n\n```json\n{\n    \"object\": {\n        \"property\": \"value\"\n    }\n}\n```\n\nwhich is equivalent to the argument `--object.property value` and the environment variable `OBJECT_PROPERTY=value`.\n\n##### Available configuration properties\n\n| Property            | Type     | Description                                                                  |\n| ------------------- | -------- | ---------------------------------------------------------------------------- |\n| frontend.title      | String   | Title displayed in the web UI.                                               |\n| server.address      | String   | Host name or IP address the server will listen on, defaults to `0.0.0.0`.    |\n| server.port         | Number   | Ports the server will listen on, defaults to `8080`.                         |\n| cache.time          | Number   | Minutes to cache gitlab related items. `0` will disable caching.             |\n| sources             | Array    | The available wikis as an array.                                             |\n| sources[i].name     | String   | The name of the wiki, used to identify the wiki to users.                    |\n| sources[i].homeslug | String   | The wiki slug displayed by default when no page has been selected.           |\n| sources[i].apitoken | String   | Token used to authenticate with the GitLab API.                              |\n| sources[i].url      | String   | Url to the GitLab instance used, for GitLab.com it is https://gitlab.com/.   |\n| sources[i].projectid| Number   | The ID of the GitLab project which contains the WIKI.                        |\n\n### Using Docker\nWhen using docker, both the `server.address` and `server.port` configurations will always be set to their defaults. Changing the port and listener address is instead managed by exposing the container on different ports using docker port mapping.\n\nStart a container instance of Staticless by running the following `docker run` command:\n\n```shell\ndocker run \\\n  -d \\\n  -v \"path/to/staticless/config/folder:/opt/app/config\" \\\n  tellios/staticless\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTellios%2Fstaticless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTellios%2Fstaticless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTellios%2Fstaticless/lists"}