{"id":20846331,"url":"https://github.com/requarks/wiki-update-companion","last_synced_at":"2025-05-09T02:59:42.195Z","repository":{"id":73217810,"uuid":"489144421","full_name":"requarks/wiki-update-companion","owner":"requarks","description":"Automatic Update Companion for Wiki.js","archived":false,"fork":false,"pushed_at":"2023-01-04T14:11:01.000Z","size":42,"stargazers_count":5,"open_issues_count":0,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-09T02:59:36.037Z","etag":null,"topics":["docker","nodejs","wiki","wiki-js"],"latest_commit_sha":null,"homepage":"https://js.wiki","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/requarks.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}},"created_at":"2022-05-05T22:33:49.000Z","updated_at":"2023-11-13T23:34:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"b444310c-f1cd-47d9-9f3b-6be9e2d65e45","html_url":"https://github.com/requarks/wiki-update-companion","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/requarks%2Fwiki-update-companion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/requarks%2Fwiki-update-companion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/requarks%2Fwiki-update-companion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/requarks%2Fwiki-update-companion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/requarks","download_url":"https://codeload.github.com/requarks/wiki-update-companion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253181418,"owners_count":21866991,"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":["docker","nodejs","wiki","wiki-js"],"created_at":"2024-11-18T02:15:49.337Z","updated_at":"2025-05-09T02:59:42.158Z","avatar_url":"https://github.com/requarks.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wiki.js Update Companion\n\nThis docker image provides automated upgrade to latest Wiki.js versions from the Administration Area.\n\nIt's part of the [DigitalOcean prebuilt Wiki.js droplet](https://marketplace.digitalocean.com/apps/wiki-js?refcode=5f7445bfa4d0) and is installed when following the [Ubuntu installation instructions](https://docs.requarks.io/install/ubuntu).\n\n## Usage\n\nWhen a new version of Wiki.js is available, go the **System** page in the **Administration Area** of your Wiki.js installation.\n\nSimply click the **Perform Upgrade** button to perform the upgrade.\n\n## Technical Reference\n\nThe wiki-update-companion container exposes a small HTTP API to the Wiki.js container *(and only the container, not to the host)*.\n\nBy sending a POST request to `http://wiki-update-companion/upgrade`, the following actions are taken:\n\n1. Stop and remove the `wiki` container\n1. Pull the latest wiki image\n1. Recreate the `wiki` container using the same settings as the previous container\n\nThe major version to use for the upgrade can be specified by adding it to the URL, e.g.:\n```\nhttp://wiki-update-companion/upgrade/3\n```\nThe default is `2` if not provided.\n\nFor security reasons, this mechanism is not part of the main Wiki.js docker image, because it would require the Docker socket to be mapped into the container. A compromised Wiki.js instance would effectively give full access to other containers on the host. By using a separate isolated container, which only exposes a single HTTP endpoint internally, this potential security risk is eliminated.\n\nThe wiki-update-companion container must:\n\n- Have the hostname `wiki-update-companion`\n- Be on the same network as the `wiki` container\n- Have the host `/var/run/docker.sock` socket mapped to the container in the same location\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frequarks%2Fwiki-update-companion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frequarks%2Fwiki-update-companion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frequarks%2Fwiki-update-companion/lists"}