{"id":13554505,"url":"https://github.com/smolijar/gitwiki","last_synced_at":"2025-10-13T15:05:17.689Z","repository":{"id":132747113,"uuid":"121372913","full_name":"smolijar/gitwiki","owner":"smolijar","description":"A git based wiki system with in-repository permission control, web user interface and Git CLI over SSH access.","archived":false,"fork":false,"pushed_at":"2018-05-11T18:13:48.000Z","size":463,"stargazers_count":3,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-06T15:14:10.794Z","etag":null,"topics":["acl","asciidoc","git","gitolite","hosting","markdown","ssh","wiki"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/smolijar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-02-13T11:07:55.000Z","updated_at":"2024-04-30T07:02:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"a87b0c65-70c9-48e4-abac-f730f207dbcc","html_url":"https://github.com/smolijar/gitwiki","commit_stats":null,"previous_names":["smolijar/gitwiki"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smolijar%2Fgitwiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smolijar%2Fgitwiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smolijar%2Fgitwiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smolijar%2Fgitwiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smolijar","download_url":"https://codeload.github.com/smolijar/gitwiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208689,"owners_count":21065205,"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":["acl","asciidoc","git","gitolite","hosting","markdown","ssh","wiki"],"created_at":"2024-08-01T12:02:49.224Z","updated_at":"2025-10-13T15:05:12.670Z","avatar_url":"https://github.com/smolijar.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","git"],"sub_categories":[],"readme":"![Gitwiki](https://i.imgur.com/Js5Y9dU.png)\n\nGitwiki is a git based wiki system with in-repository permisison control, web user interface and Git CLI over SSH access.\n\n# About\nIt uses [Gitolite](http://gitolite.com/gitolite/index.html) authorization layer allowing complex, in-repository access control.\n\nGitwiki is part of an implementation for the [Git-based Wiki System](https://github.com/grissius/gitwiki-thesis).\n\nIt uses [Emily editor](https://github.com/grissius/emily-editor) for document editting.\n\n\n# Install\nThe installation process is complicated, because repository hosting service over SSHd must be established.\n\n## Gitolite\n\n### Gitolite installation\n\nThis installation prociess is thoroughly explained [here](http://gitolite.com/gitolite/fool_proof_setup/).\nHere is a step-by-step solution for Debian-based distributions.\n\nGenerate SSH keys:\n\n```sh\n# install git, sshd\nsudo apt-get install openssh-server git\n# generate a keypair for administration\nssh-keygen -t rsa -b 4096 -C \"gitolite-admin\" -f \"$HOME/.ssh/gitolite-admin\"\n# copy the \"~/.ssh/gitolite-admin.pub\" for gitolite setup\ncp ~/.ssh/gitolite-admin.pub /tmp\n```\n\nInstall Gitolite:\n\n```sh\n# create new `git` user with home directory and set password\nsudo useradd -m git\nsudo passwd git\n\n# switch to git user\nsu - git\n\n# download and install gitolite\ncd $HOME\ngit clone https://github.com/sitaramc/gitolite\nmkdir -p bin\ngitolite/install -to $HOME/bin # use abs path in argument\n\n# setup gitolite with copied admin key from workstation\n$HOME/bin/gitolite setup -pk /tmp/gitolite-admin.pub\n```\n### Additional Gitolite setup\nWee need gitwiki to be able to access Gitolite.\nIf you will be running gitwiki from a different user (assume username `jack`), you must perform additional setup.\n\nCreate group, add users *git*, *jack*, allow to write in `/home/git/.gitolite`\n```sh\nsudo groupadd gitolite\nsudo usermod -a -G gitolite jack\nsudo usermod -a -G gitolite git\nsudo chgrp -R gitolite /home/git/\nsudo chmod -R 2775 /home/git/.gitolite\n```\n\nSet `setgid` bit\n\n```sh\nchmod g+s /home/git/\n```\n\nSet default permissions for new log files\n\n```sh\nsudo setfacl -d -m g::rwx /home/git/.gitolite/logs/\n```\n\n## Gitwiki\n\n### Install\n```sh\nnpm install\n```\n\n### Setup\n#### Authentication\n\n1. [Register a new OAuth application](https://github.com/settings/applications/new)\n    - Set callback to `\u003chost\u003e/api/v1/auth/github/cb`\n2. Remember `client_id` and `client_secret`\n\n#### Configuration\n\nCreate a `.gitwiki.config.js` and fill the data as in `.gitwiki.config.example.js`.\n\n```js\nmodule.exports = {\n  auth: {\n    oauth2: {\n      github: {\n        // Information from the newly registered app\n        client_id: '...',\n        client_secret: '...',\n      }\n    }\n  },\n  gitolite: {\n    // Path to gitolite bin\n    bin: '/home/git/bin/gitolite',\n    // Home directory of the gitolite's user\n    home: '/home/git',\n  },\n  // Valid storage path for keyv(https://github.com/lukechilds/keyv)\n  storage: 'sqlite:///home/git/database.sqlite',\n};\n```\n\n# Running\n\n1. Add ssh key identity `ssh-add ~/.ssh/gitolite-admin` (path to private key you configured gitolite with)\n2. `npm run start`\n\n# Usage\n\n## Repository providers\n\n- Gitolite\n- GitHub\n\nTo access GitHub repositories, you will be prompted to enter your _personal access token_ in repository index. When provided, you can access your GitHub repositories apart from the default local (gitolite) repositories.\n\n## Adding SSH keys\n\nThe SSH keys are downloaded from GitHub on the first login and added to the Gitolite configuration.\nApart from that, they can be added using Gitolite.\n\n## Permission control\n\nThis option is only available for Gitolite provider, for self-hosted repos.\nAfter a succesful Gitolite setup, there is a repository `gitolite-admin`, where you can add users and chagne their permissions.\nIf you are new to Gitolite, see [Basic administration](http://gitolite.com/gitolite/basic-admin/) manual.\n\n# License\n\nThis project is licensed under the [MIT license](./LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmolijar%2Fgitwiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmolijar%2Fgitwiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmolijar%2Fgitwiki/lists"}