mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-12-12 05:20:26 +00:00
Code Issues Releases Wiki Activity

Remove PKGBUILD, add how to install from AUR

Browse Source
This commit is contained in:
handlerug 2021-06-12 22:51:29 +07:00
parent 59f91482c0
commit 71b3b42e54
No known key found for this signature in database
GPG Key ID: 38009F0605051491
2 changed files with 42 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
PKGBUILD
View File

@ -1,17 +0,0 @@
pkgname=mycorrhiza
pkgver=1.1.0
pkgrel=1
pkgdesc="Filesystem and git-based wiki engine written in Go using mycomarkup as its primary markup language."
arch=('x86_64' 'i686')
url="https://github.com/bouncepaw/mycorrhiza"
license=('AGPL3')
depends=('git')
source_x86_64=("$pkgname-$pkgver.tar.gz::https://github.com/bouncepaw/mycorrhiza/releases/download/v$pkgver/mycorrhiza-v$pkgver-linux-amd64.tar.gz")
source_i686=("$pkgname-$pkgver.tar.gz::https://github.com/bouncepaw/mycorrhiza/releases/download/v$pkgver/mycorrhiza-v$pkgver-linux-868.tar.gz")
md5sums_x86_64=('aa62f1c71f082332df4f67d40c8dcdbd')
md5sums_i686=('aa62f1c71f082332df4f67d40c8dcdbd')
package() {
install -Dm755 "mycorrhiza" "$pkgdir/usr/bin/mycorrhiza"
}

84
README.md
View File

@ -3,48 +3,7 @@ A wiki engine.
[Main wiki](https://mycorrhiza.lesarbr.es)
## Building
See [the guide](https://mycorrhiza.lesarbr.es/hypha/guide/deployment) on the wiki.
## Installing
### Pacman
If you use a linux distro with pacman package manager (Arch, Manjaro, Garuda, etc) you can install it using PKGBUILD:
```sh
$ wget https://raw.githubusercontent.com/bouncepaw/mycorrhiza/master/PKGBUILD
$ makepkg --install
```
### Docker
You can run Mycorrhiza Wiki in Docker using Dockerfile provided by this repository. Clone the repo and build the image:
```sh
$ git clone https://github.com/bouncepaw/mycorrhiza/
$ docker build -t mycorrhiza .
```
Now you can create a new Mycorrhiza Wiki container using this command:
```sh
$ docker run -v /full/path/to/my/wiki:/wiki -p 1737:1737 mycorrhiza
```
Example:
```sh
$ cd /dev/shm
$ git clone https://github.com/bouncepaw/mycorrhiza/
$ docker build -t mycorrhiza .
$ git clone https://github.com/bouncepaw/example-wiki
$ docker run -v /dev/shm/example-wiki:/wiki -p 1737:1737 mycorrhiza
```
Example 2:
```sh
...
$ docker run -v /dev/shm/:/config -v /dev/shm/example-wiki:/wiki -p 80:1737 mycorrhiza -config-path /config/myconfig.ini /wiki
```
## Usage
# Usage
```
mycorrhiza [OPTIONS...] WIKI_PATH
@ -75,6 +34,47 @@ Options:
* Authorization with pre-set credentials, registration
* Basic Gemini protocol support
# Building
See [the guide](https://mycorrhiza.lesarbr.es/hypha/guide/deployment) on the wiki.
# Installing
## AUR
You can install Mycorrhiza Wiki from AUR using your favorite package manager on any Arch Linux-derivative distro (Arch, Manjaro, Garuda, etc):
```sh
yay -S mycorrhiza # or mycorrhiza-bin if you don't want to
# build it from scratch
```
## Docker
You can run Mycorrhiza Wiki in Docker using Dockerfile provided by this repository. Clone the repo and build the image:
```sh
git clone https://github.com/bouncepaw/mycorrhiza/
docker build -t mycorrhiza .
```
Now you can create a new Mycorrhiza Wiki container using this command:
```sh
docker run -v /path/to/wiki:/wiki -p 1737:1737 mycorrhiza
```
Example:
```sh
cd /dev/shm
git clone https://github.com/bouncepaw/mycorrhiza/
docker build -t mycorrhiza .
git clone https://github.com/bouncepaw/example-wiki
docker run -v /dev/shm/example-wiki:/wiki -p 1737:1737 mycorrhiza
```
Example 2:
```sh
# ...
docker run -v /dev/shm/:/config -v /dev/shm/example-wiki:/wiki -p 80:1737 mycorrhiza -config-path /config/myconfig.ini /wiki
```
## Contributing
Help is always needed. We have a [tg chat](https://t.me/mycorrhizadev) where some development is coordinated. You can also sponsor bouncepaw on [boosty](https://boosty.to/bouncepaw). Feel free to open an issue or contact us directly.