You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
8
8
9
-
#### Private File
10
-
11
-
Please contact us for an example of the private file. You cannot run the program without it.
12
-
13
-
#### Install MySQL Server
14
-
15
-
#### setup the database
16
-
* change the root mysql account to one written in private file.
17
-
* make sure you can log in to mysql with the password in the command line: `mysql -u root -p`
@@ -29,89 +19,25 @@ Please contact us for an example of the private file. You cannot run the program
29
19
30
20
To install the Docker Engine select your [Linux distribution](https://docs.docker.com/engine/install/#server) and follow the instructions to install.
31
21
32
-
Currently you need a gmail account in order for Murmur to send verification emails, such as registration confirmation. In order for Murmur to log in to your gmail account you need to [enable less secure logins](https://support.google.com/accounts/answer/6010255?hl=en).
22
+
Currently you need a gmail account in order for Murmur to send verification emails, such as registration confirmation.
33
23
34
24
Next set up the environment variables. The only variables you should need to set are your gmail username and password.
35
25
36
26
1.`cp .env.example .env`
37
-
2. Fill in the correct values in `.env` for your gmail account. Make sure to enable insecure logins on gmail.
38
-
3. Use `make` to create the database and create a superuser account to login
39
-
4. Check it out on `localhost:8000
40
-
41
-
#### Starting and Stopping Docker
42
-
43
-
In order to stop docker you can simply run `make stop` and run `make start` to start it up again.
* create file /opt/murmur/env with single word containing "dev", "staging", or "prod" for the type of server you are setting up
74
-
* create file /opt/murmur/debug with single word containing "true" or "false" to turn on debug mode
75
-
* edit file /opt/murmur/website with single word containing "murmur" or "squadbox" to direct to the respective landing page
76
-
* If using Google integration, create a Google API project and enable the Gmail, People and Contacts APIs; generate an Oauth2 client_secrets.json file for this project and put this in the /gmail_setup/ directory
77
-
* Run [this command](https://github.com/haystack/murmur/blob/master/mysql_encoding) at mysql
27
+
2. Fill in the correct values in `.env` for your gmail account. Put your gmail address and a google app password.
28
+
3.`cp private.py.example private.py`
29
+
4. Fill in the correct values in `private.py` such as your AWS IDs for message-attachment storage.
30
+
5. Use `make` to create the database and create a superuser account to login
31
+
6. Check it out on `localhost:8000`
78
32
79
33
#### setup the database
80
-
*`mysql -u root -p`
81
-
*`create database murmur;`
82
-
* Give privileges to the user that will access the database from django: `grant all privileges ON murmur.* TO root@localhost;`
83
-
84
-
#### install schema and create superuser
85
-
*`python manage.py syncdb`and create superuser
86
-
* Convert schema app to be managed by South: `python manage.py schemamigration schema --initial`
87
-
* Then do fake migration: `python manage.py migrate schema 0001 --fake`
88
-
89
-
#### run murmur server
90
-
* Webserver: `python manage.py runserver 0.0.0.0:8000` (check [here](https://www.digitalocean.com/community/tutorials/how-to-serve-django-applications-with-apache-and-mod_wsgi-on-ubuntu-16-04) for details)
91
-
92
-
### Email Instructions
93
-
94
-
Setting for relay & outgoing server is in `config/settings.py` (Double check you open firewall for the ports)
95
-
96
-
#### Postfix setting (if you are using postfix as a relay system)
34
+
* change the root mysql account to one written in `.env`
35
+
* make sure you can log in to mysql with the password in the command line: `mysql -u root -p`
97
36
98
-
If you are using Postfix, you should update two postfix files:
99
37
100
-
1.`master.cf`: add a line `RELAY_PORT_YOU_SPECIFIED_at_config/settings.py inet n - n - - smtpd`
101
-
2.`main.cf`:
102
-
```
103
-
mydestination =
104
-
local_recipient_maps =
105
-
local_transport = error: local mail delivery disabled
106
-
relay_domains = YOUR DOMAIN NAME
107
-
relay_transport = smtp:127.0.0.1:[RECEIVER PORT YOU SPECIFIED at config/settings.py]
108
-
```
38
+
#### Starting and Stopping Docker
109
39
110
-
Then reboot Postfix.
40
+
In order to stop docker you can simply run `make stop` and run `make start` to start it up again.
111
41
112
-
#### run murmur server
113
-
* If running email server: `lamson start`
114
-
+ ⚠️ If it is not running without any error msg or throws `connection refused` error, then check your email port being used by other services (e.g., `netstat -peanut | grep ":8825"`) and check logs at logs/lamson.err. If the port is being used, use another port or kill the process using the port.
115
42
116
-
#### enable daily digest feature
117
-
*`crontab -e` and add a line `0 */24 * * * python ABSOLUTE_DIRECTORY/manage.py digest`
43
+
If you want to deploy Murmur on your own server and domain, check out the [advanced settings](https://github.com/haystack/murmur/wiki/Advanced-set-up:-server-deployment)
0 commit comments