BookWyrm for YunoHost

Lire ce readme en français.

This package allows you to install BookWyrm quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.

Shipped version: 0.5.3~ynh1

Demo: https://joinbookwyrm.com/fr/

Screenshots

Disclaimers / important information

• Any known limitations, constrains or stuff not working, such as (but not limited to):

  • requiring a full dedicated domain ?
  • architectures not supported ?
  • not-working single-sign on or LDAP integration ?
  • the app requires an important amount of RAM / disk / .. to install or to work properly
  • etc...

• Other infos that people should be aware of, such as:

  • any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
  • how to configure / administrate the application if it ain't obvious
  • upgrade process / specificities / things to be aware of ?
  • security considerations ?

Documentation and resources

• Official app website: https://joinbookwyrm.com/fr/
• Official admin documentation: https://docs.joinbookwyrm.com/
• Upstream app code repository: https://github.com/bookwyrm-social/bookwyrm
• YunoHost documentation for this app: https://yunohost.org/app_bookwyrm
• Report a bug: https://github.com/YunoHost-Apps/bookwyrm_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
or
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps