YunoHost-Apps/discourse_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/discourse_ynh.git synced 2024-09-03 18:26:18 +02:00
Code Issues Activity Actions
discourse_ynh/README.md
Jimmy Monin 0fae168464 Add README, LICENSE, check_process
2018-04-29 16:41:28 +02:00

5.3 KiB
Raw Blame History

Discourse for YunoHost

Integration level
Install Discourse with YunoHost

This package allow you to install discourse quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy it.

Disclaimer

This package installs Discourse without Docker, for several reasons (mostly to support ARM architecture and low-profile servers, to mutualize nginx/postgresql/redis services and to simplify e-mail setup). As stated by the Discourse team:

The only officially supported installs of Discourse are Docker based. You must have SSH access to a 64-bit Linux server with Docker support. We regret that we cannot support any other methods of installation including cpanel, plesk, webmin, etc.

So please have this in mind when considering asking for Discourse support.

Moreover, you should have in mind Discourse hardware requirements:

  • modern single core CPU, dual core recommended
  • 1 GB RAM minimum (with swap)
  • 64 bit Linux compatible with Docker
  • 10 GB disk space minimum

Finally, if installing on a low-end ARM device (e.g. Raspberry Pi), first access right after installation could take a couple of minutes.

Overview

Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:

  • mailing list
  • discussion forum
  • long-form chat room

To learn more about the philosophy and goals of the project, visit discourse.org.

Shipped version: 1.9.4

Screenshots

Boing Boing

Mobile

Configuration

Use the admin panel of your discourse to configure this app.

Documentation

  • Official documentation: https://www.discourse.org/
  • YunoHost documentation: There no other documentations, feel free to contribute.

YunoHost specific features

  • Integration with YunoHost users and SSO:
    • LDAP integration: on the login pop-up, you can choose "Login with LDAP" and use your YunoHost credentials
    • private mode: Forum only accessible by YunoHost users
    • public mode: Visible by anyone

Multi-users support

Supported, with LDAP and SSO.

Login Popup

Default administrator and YunoHost users must login using LDAP:

  • click on the "with LDAP" button
  • use your YunoHost credentials

When disabling Local Login and other authentication services, clicking the Login or Sign Up button will directly bring up the LDAP Login popup.

Disable Local

LDAP Login Popup

Supported architectures

  • Tested on x86_64
  • Tested on ARM

Limitations

Known non impacting log messages:

fatal: Not a git repository (or any of the parent directories): .git

bash: BASH_XTRACEFD: 7: invalid value for trace file descriptor

svgo worker: `svgo` not found; please provide proper binary or disable this worker (--no-svgo argument or `:svgo => false` through options)

How-tos

Install plugins

cd /var/www/discourse
sudo -i -u discourse RAILS_ENV=production bin/rake --trace plugin:install repo=https://github.com/discourse/discourse-solved (for example)
sudo -i -u discourse RAILS_ENV=production bin/rake --trace assets:precompile
systemctl restart discourse-puma

Links

Developers infos

Please do 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/discourse_ynh/tree/testing --verbose
or
sudo yunohost app upgrade discourse -u https://github.com/YunoHost-Apps/discourse_ynh/tree/testing --verbose