Flatpak manifest for Federated Wiki

Another way of distributing Federated Wiki. This time with Flatpak.

Prerequisites

• flatpak-builder
• A local Node.JS instance is used to generate a package-lock.json from the distributed Wiki tarball found on NPM
• You will need to clone and install flatpak-node-generator to generate generated-sources.json

Prepare

We need to prepopulate the NPM cache with distribution artifacts from all dependencies named in package.json.

bin/prepare.sh

Exemplary files come with this repository for convenience.

Build and install

Build the application into build-dir with using the org.wiki.fed.yaml manifest.

Choose to --install to the current --user and --force-clean the build area.

flatpak-builder --user --install --force-clean build-dir org.wiki.fed.yaml

Optional: prepare configuration

To get started quickly, you can prepare a simple configuration for your wiki.

 cat <<<"{                   
  "security_type": "friends",
  "cookieSecret": "$(pwgen -n 64 1 | sed -z "s/\n//g")",
  "session_duration": 365
}
" > $HOME/.wiki/config.json

Run

Just run it!

flatpak run org.wiki.fed

Your local wiki is now available at http://localhost:3000

Clean

Clean all generated files with:

bin/clean.sh

Authors

• Jon Richter

License

MIT license. See provided LICENSE.txt file for details.

Copyright

© 2024 Ecobytes e.V., Jon Richter