Murmur uses Django with a MySQL backend (you can replace with any other backend Django supports). For email, we use postfix along with the python lamson library.
git clone https://github.com/haystack/murmur.git
Recommended to use Linux
To install the Docker Engine select your Linux distribution and follow the instructions to install.
Currently you need a gmail account in order for Murmur to send verification emails, such as registration confirmation.
Next set up the environment variables. The only variables you should need to set are your gmail username and password.
cp .env.example .env
- Fill in the correct values in
.env
for your gmail account. Put your gmail address and a google app password. cp private.py.example private.py
- Fill in the correct values in
private.py
such as your AWS IDs for message-attachment storage. - Use
make
to create the database and create a superuser account to login - Check it out on
localhost:8000
- change the root mysql account to one written in
.env
- make sure you can log in to mysql with the password in the command line:
mysql -u root -p
In order to stop docker you can simply run make stop
and run make start
to start it up again.
If you want to deploy Murmur on your own server and domain, check out the advanced settings