https://github.com/stephenreid321/lumen

Open-source group discussion platform. Written in Ruby (Padrino), hosted via DigitalOcean/dokku. No longer in active development
https://github.com/stephenreid321/lumen

Last synced: about 1 month ago
JSON representation

Open-source group discussion platform. Written in Ruby (Padrino), hosted via DigitalOcean/dokku. No longer in active development

• Host: GitHub
• URL: https://github.com/stephenreid321/lumen
• Owner: stephenreid321
• License: gpl-3.0
• Archived: true
• Created: 2013-11-21T17:04:13.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2017-12-08T17:18:02.000Z (about 7 years ago)
• Last Synced: 2024-08-02T12:49:29.415Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 12.6 MB
• Stars: 52
• Watchers: 12
• Forks: 10
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• awesome-starred - stephenreid321/lumen - Open-source group discussion platform. Written in Ruby (Padrino), hosted via DigitalOcean/dokku. No longer in active development (others)

README

        
# Lumen

[![Build Status](https://travis-ci.org/wordsandwriting/lumen.svg?branch=master)](https://travis-ci.org/wordsandwriting/lumen)

Lumen is an open-source group discussion platform with dual web-email access.

It can be compared to [Discourse](http://discourse.org/), [Loomio](http://loomio.org/), [Slack](http://slack.com/), [Google Groups](http://groups.google.com) or [Facebook Groups](http://facebook.com/groups). An outline of its features:

* Open-source (under [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-nc-sa/3.0/))

* Hosted using DigitalOcean/dokku

* Designed for custom domains (group email addresses of the form [email protected])

* Sends and receives mail via regular SMTP and IMAP accounts

* Dual web/email access

* Extensible member profiles

* Loomio-style proposals

* Events calendar

* Maps placing people, organisations and venues

* Google Docs integration

* Optional Facebook-style wall view

Lumen is written in Ruby using the [Padrino](http://padrinorb.com/) framework. It was originally created for the [New Economy Organisers Network](http://neweconomyorganisersnetwork.org/) (hosted by the [New Economics Foundation](http://neweconomics.org/)) who kindly agreed to open source the project and continue to sponsor its development.

## How the mailing lists work, in brief

1. Your mail server receives a mail to [email protected]

2. The mail triggers a simple notification script on the mail server that in turn alerts your web app to the fact there's a new message for the group

3. Your web app connects to the mail server via IMAP to fetch the new mail

4. Your web app distributes the message to group members via SMTP

## Installation instructions

* Create a 2GB (or greater) droplet, which will act as both your web and mail server, with the image 'Dokku 0.9.4 on 16.04' and hostname `$DOMAIN` (this could be a root domain like lumenapp.com, or a subdomain like network.lumenapp.com). SSH into the server via `ssh root@$DROPLET_IP`.

* Run the installation script, replacing `$DROPLET_IP` and `$DOMAIN` with the appropriate values:

  ```

  wget https://raw.github.com/wordsandwriting/lumen/master/script/lumen-install.sh; chmod +x lumen-install.sh; ./lumen-install.sh $DROPLET_IP $DOMAIN

  ```

* Add DNS records (get DKIM key with `nano -$ /etc/opendkim/keys/$DOMAIN/mail.txt`):

  ```

  $DOMAIN MX $DOMAIN

  $DOMAIN A $DROPLET_IP  

  $DOMAIN TXT "v=spf1 mx -all"  

  mail._domainkey.$DOMAIN TXT "v=DKIM1; k=rsa; p=..."

  ```

* Visit `$DOMAIN`. (You should be automatically logged in as an administrator. If not, sign in with the email address `[email protected]` and the password `lumen`.) Change the admin name, email address and password, then click 'Configuration' in the footer to set configuration variables. You're done!

## Switching mail servers

If you switch your mail server, you'll need to re-setup the group mail accounts on the new server. Fire up a console (`padrino c`) and run:

```

Group.each { |group| group.setup_mail_accounts_and_forwarder }

ConversationPost.update_all(imap_uid: nil)

```