https://github.com/ably/wiki-site
Convert your GitHub wiki into your own personalised site. Check more information on the choices made at https://blog.ably.io/hacking-github-to-build-your-own-wiki-ab08aab58db1
https://github.com/ably/wiki-site
Last synced: 6 months ago
JSON representation
Convert your GitHub wiki into your own personalised site. Check more information on the choices made at https://blog.ably.io/hacking-github-to-build-your-own-wiki-ab08aab58db1
- Host: GitHub
- URL: https://github.com/ably/wiki-site
- Owner: ably
- License: other
- Created: 2018-07-04T08:59:03.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T02:29:49.000Z (over 2 years ago)
- Last Synced: 2025-03-11T19:49:22.156Z (over 1 year ago)
- Language: HTML
- Size: 34.2 KB
- Stars: 20
- Watchers: 7
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Wiki
====
This repository can be used to host a GitHub wiki
## Authentication
This app relies on Auth0 for authentication. See [`.env.example`](.env.example) for the environment variables needed. It is recommended you configure a Rule in Auth0 to limit authentication to a Google Apps domain.
## Running this locally
Copy [`.env.example`](.env.example) to `.env` and configure the environment variables if you want to use Auth0. Otherwise, add `AUTH_DISABLED=true` to `.env` to disable auth for local development.
`bundle`
Install the gems:
`bundle`
Build the static site:
`jekyll build`
Then run the server:
`rackup`
## Installation on Heroku
Configure the [environment variables](.env.example), and push the repo and that's it :)
Copyright (c) 2018 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to [LICENSE](LICENSE) for the license terms.