Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/YGGverse/bdoku
DokuWiki Satellite for Gemini Protocol
https://github.com/YGGverse/bdoku
bdoku beta-doku betadoku betahowto composer dokuwiki gemini gemini-bridge gemini-dokuwiki gemini-protocol gemini-rotocol-server gemini-server manticore wiki
Last synced: about 2 months ago
JSON representation
DokuWiki Satellite for Gemini Protocol
- Host: GitHub
- URL: https://github.com/YGGverse/bdoku
- Owner: YGGverse
- License: mit
- Created: 2024-01-30T09:52:54.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-07T11:20:52.000Z (7 months ago)
- Last Synced: 2024-04-08T21:36:45.436Z (5 months ago)
- Topics: bdoku, beta-doku, betadoku, betahowto, composer, dokuwiki, gemini, gemini-bridge, gemini-dokuwiki, gemini-protocol, gemini-rotocol-server, gemini-server, manticore, wiki
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gemini - repo
README
# β-Doku is DokuWiki Satellite for Gemini Protocol
Allows to launch read-only DokuWiki instance using [Gemini Protocol](https://geminiprotocol.net/)
It based on [titan-II](https://github.com/YGGverse/titan-II) server, [gemini-php](https://github.com/YGGverse/gemini-php) to parse DokuWiki data folder, [cache-php](https://github.com/YGGverse/cache-php) to save compiled pages in memory and [manticore](https://github.com/manticoresoftware) for full-text search.
Project under development, please join to work by sending PR or bug report!
## Examples
* `gemini://[301:23b4:991a:634d::b]` - Mirror of `http://[222:a8e4:50cd:55c:788e:b0a5:4e2f:a92c]`
* `gemini://betahowto.ygg` - Alfis / Yggdrasil alias
* `gemini://betahowto.duckdns.org` - Clearnet alias
## Install
1. `wget https://repo.manticoresearch.com/manticore-repo.noarch.deb`
2. `dpkg -i manticore-repo.noarch.deb`
3. `apt update`
4. `apt install git composer memcached manticore manticore-extra php-fpm php-memcached php-mysql php-mbstring`
5. `git clone https://github.com/YGGverse/bdoku.git`
6. `cd bdoku`
7. `composer update`
## Setup
1. `cd bdoku`
2. `mkdir host/127.0.0.1`
3. `cp example/config.json host/127.0.0.1/config.json`
4. `cd host/127.0.0.1`
5. `openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem -days 365 -nodes -subj "/CN=127.0.0.1"`
## Start
Before launch the server, copy or create alias of `path/to/dokuwiki/data` folder to `bdoku/host/127.0.0.1` on example above.
On every start, previous memory cache will be cleaned and new search index created.
After `data` folder update, you need just to restart your server with systemd or another process manager.
When launching with systemd, just make sure that manticore server already running:
```
[Unit]
Wants=manticore.service
After=manticore.service
...
```
`php src/server.php 127.0.0.1`
Open `gemini://127.0.0.1` in your favorite [Gemini browser](https://github.com/kr1sp1n/awesome-gemini)!
## Update
1. `cd bdoku`
2. `git pull` - get latest codebase from this repository
3. `composer update` - update vendor libraries