# wikijs-rs
API bindings, CLI client and FUSE filesystem for [Wiki.js](https://js.wiki/)
written in Rust.
[](https://github.com/gierens/wikijs-rs/actions/workflows/testing.yml)
**What's inside?**
- [Library](#library): Rust bindings to Wiki.js's entire GraphQL API as well
as asset up- and download via the REST API.
**Usable but not battle-tested**
- [CLI](#cli): Command-line client for those bindings allowing things like
editing pages with your editor.
**Usable but not complete yet**
- [Filesystem](#filesystem): A FUSE filesystem to mount your wiki and work on it locally.
**Not usable yet, heavily work-in-progress.**
## Library
The library basically gives you a struct `Api` that you hand the url and
credentials for you Wiki.js instance to, and that exposes functions for all
the different GraphQL queries and mutations as well as asset down- and upload
via the REST API. For detailed information check the
[documentation](https://docs.rs/wikijs), otherwise here a short example:
### Usage
Add the following dependency to your `Cargo.toml`:
```toml
[dependencies]
wikijs = "0.2"
```
Create an instance of `Api` and use its functions:
```rust
use wikijs::{Api, Credentials};
let api = Api::new(
"http://localhost:3000".to_string(),
Credentials::Key("my-api-key".to_string()),
).unwrap();
println!("{:?}", api.page_get(1).unwrap());
```
## CLI
This crate ships a command-line tool also called `wikijs` to directly interact
with your Wiki.js instance from the CLI. On top of exposing the library
functions it also offers additional functionality like editing pages with
your favorite editor.
### Build
```bash
cargo build --features=cli
```
### Install
The CLI is packaged via cargo, as well as Debian and AUR package, see
[Installation](#installation) for details.
### Usage
The tool takes the URL and credentials either from the arguments or
environment variables. For the latter option use something like this:
```bash
export WIKI_JS_BASE_URL=https://wiki.mydomain.com
export WIKI_JS_API_KEY=MY-SUPER-SECRET-API-KEY
```
or for password authentication use:
```bash
export WIKI_JS_USERNAME="USERNAME or EMAIL"
export WIKI_JS_PASSWORD="PASSWORD"
```
Note, in case you're using something else then the default authentication
provider like LDAP, you have to set the variable `WIKI_JS_AUTH_PROVIDER` to
its UUID.
Then you can for example create a page named `test`, list pages and edit it
with:
```bash
wikijs page create test
wikijs page list
wikijs page edit
```
where the `ID` is found in the `page list` output.
## Filesystem
**WARNING: Not really usable yet! Careful!**
**Also in case you wanna PR on
this please coordinate via issues, as I'm currently heavily refactoring this
to add a caching layer and include assets.**
This crate also ships FUSE filesystem called `wikifs` to mount your Wiki.js
instance locally and view and manipulate it with what ever programs you like.
### Build
```bash
cargo build --features=fuse
```
### Install
```bash
cargo install wikijs --features=fuse
```
### Usage
The tool takes the URL and credentials either from the arguments or
environment variables. For the latter option use something like this:
```bash
export WIKI_JS_BASE_URL=https://wiki.mydomain.com
export WIKI_JS_API_KEY=MY-SUPER-SECRET-API-KEY
```
Then you can mount the filesystem like so:
```bash
mkdir /tmp/wikijs
wikifs /tmp/wikijs
```
And in another terminal use it like this:
```bash
cd /tmp/wikijs
ls
cat test.md
```
provided you have a `markdown` page located at `/test` in your wiki.
## Installation
These instructions are for the CLI only so far, as the FUSE filesystem is not
ready to be shipped.
### Cargo
Run the following to install the CLI from [crates.io](https://crates.io):
```bash
cargo install wikijs --features=cli
```
### Arch
The CLI is available on [AUR](https://aur.archlinux.org/packages/wikijs-rs).
### Debian and Ubuntu
The CLI is available from [deb.gierens.de](http://deb.gierens.de). The GPG
public key is in this repo under [deb.asc](/deb.asc).
First make sure you have the `gpg` command, and otherwise install it via:
```bash
sudo apt update
sudo apt install -y gpg
```
Then install `wikijs-rs` via:
```bash
sudo mkdir -p /etc/apt/keyrings
wget -qO- https://raw.githubusercontent.com/gierens/wikijs-rs/main/deb.asc | sudo gpg --dearmor -o /etc/apt/keyrings/gierens.gpg
echo "deb [signed-by=/etc/apt/keyrings/gierens.gpg] http://deb.gierens.de stable main" | sudo tee /etc/apt/sources.list.d/gierens.list
sudo chmod 644 /etc/apt/keyrings/gierens.gpg /etc/apt/sources.list.d/gierens.list
sudo apt update
sudo apt install -y wikijs-rs
```
## Contributing
Use small commits that make isolated changes to a single module and name them
according to [conventional commits](https://www.conventionalcommits.org/).
Two parts where especially first-time contributions should be fairly easy and
are also really needed is writing docstrings and integration tests. Apart from
that the CLI still needs to implement many of the library functions.
Please check issues and PRs first and maybe make an issue or draft PR of your
own so we can coordinate work. This is especially important for the FUSE
filesystem, as I'm currently heavily refactoring that.
## Testing
Since this depends on Wiki.js the integration tests located in [tests/](tests)
can also not be done without it. Therefore the
[docker-compose.yml](docker-compose.yml) is used to run a local instance of it
on port 80. This setup is also used in the CI workflows. Note that many tests
assume the wiki to be fresh, no pages no anything ... that's why there is also
no Docker volume, so that on every rebuild all previous data is lost. This also
means you should make sure you removed everything yourself from the instance
during debugging when testing.
The tests furthermore assume the wiki to have the following admin credentials:
- email: `admin@admin.com`
- password: `password`
To set this up automatically on initial startup of the wiki, you may use
[scripts/finalize_wiki_setup.sh](scripts/finalize_wiki_setup.sh) which also
assumes the wiki to run on `http://localhost:80`.
## License
This projects is licensed under [AGPL-3.0](/LICENSE) since
[Wiki.js](https://github.com/requarks/wiki) is, too.