Browse Source

give branding

main
ghost 11 months ago
parent
commit
6c5b90c71f
  1. 12
      README.md
  2. 6
      composer.json
  3. 2
      example/config.json

12
README.md

@ -1,4 +1,4 @@
# DokuWiki Gemini Server # β-howto is DokuWiki Satellite for Gemini Protocol
Allows to launch read-only DokuWiki instance using [Gemini Protocol](https://geminiprotocol.net/) Allows to launch read-only DokuWiki instance using [Gemini Protocol](https://geminiprotocol.net/)
@ -18,13 +18,13 @@ Project under development, please join to work by sending PR or bug report!
2. `dpkg -i manticore-repo.noarch.deb` 2. `dpkg -i manticore-repo.noarch.deb`
3. `apt update` 3. `apt update`
4. `apt install git composer memcached manticore manticore-extra php-fpm php-memcached php-mysql php-mbstring` 4. `apt install git composer memcached manticore manticore-extra php-fpm php-memcached php-mysql php-mbstring`
5. `git clone https://github.com/YGGverse/dokuwiki-gemini-server.git` 5. `git clone https://github.com/YGGverse/betahowto.git`
6. `cd dokuwiki-gemini-server` 6. `cd betahowto`
7. `composer update` 7. `composer update`
## Setup ## Setup
1. `cd dokuwiki-gemini-server` 1. `cd betahowto`
2. `mkdir host/127.0.0.1` 2. `mkdir host/127.0.0.1`
3. `cp example/config.json host/127.0.0.1/config.json` 3. `cp example/config.json host/127.0.0.1/config.json`
4. `cd host/127.0.0.1` 4. `cd host/127.0.0.1`
@ -32,7 +32,7 @@ Project under development, please join to work by sending PR or bug report!
## Start ## Start
Before launch the server, copy or create alias of `path/to/dokuwiki/data` folder to `dokuwiki-gemini-server/host/127.0.0.1` on example above. Before launch the server, copy or create alias of `path/to/dokuwiki/data` folder to `betahowto/host/127.0.0.1` on example above.
On every start, previous memory cache will be cleaned and new search index created. 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. After `data` folder update, you need just to restart your server with systemd or another process manager.
@ -43,6 +43,6 @@ Open `gemini://127.0.0.1` in your favorite [Gemini browser](https://github.com/k
## Update ## Update
1. `cd dokuwiki-gemini-server` 1. `cd betahowto`
2. `git pull` - get latest codebase from this repository 2. `git pull` - get latest codebase from this repository
3. `composer update` - update vendor libraries 3. `composer update` - update vendor libraries

6
composer.json

@ -1,7 +1,7 @@
{ {
"name": "yggverse/dokuwiki-gemini-server", "name": "yggverse/betahowto",
"description": "DokuWiki bridge for Gemini Protocol", "description": "DokuWiki Satellite for Gemini Protocol",
"keywords": [ "yggverse", "gemini", "gemini-protocol", "gemini-server", "wiki", "dokuwiki", "manticore", "bridge", "server" ], "keywords": [ "yggverse", "betahowto", "gemini", "gemini-protocol", "gemini-server", "wiki", "dokuwiki", "manticore", "bridge", "server" ],
"homepage": "https://github.com/yggverse/dokuwiki-to-gemini", "homepage": "https://github.com/yggverse/dokuwiki-to-gemini",
"type": "project", "type": "project",
"require": { "require": {

2
example/config.json

@ -74,6 +74,6 @@
"source":"Source", "source":"Source",
"alias":"Alias", "alias":"Alias",
"welcome":"About", "welcome":"About",
"about":"=> https://github.com/YGGverse/dokuwiki-gemini-server GitHub" "about":"=> https://github.com/YGGverse/betahowto GitHub"
} }
} }
Loading…
Cancel
Save