Django/Production - Revision history

Brodriguez: Correct permission values

2026-01-09T12:51:42Z

Correct permission values

← Older revision		Revision as of 12:51, 9 January 2026
Line 104:		Line 104:
	This can be done by creating the following files with the respective contents:		This can be done by creating the following files with the respective contents:
	{{ hc \|/etc/tmpfiles.d/daphne.conf\|		{{ hc \|/etc/tmpfiles.d/daphne.conf\|
	d /run/daphne ~~0755~~ www-data www-data -		d /run/daphne 0775 www-data www-data -
	d /var/log/daphne ~~0755~~ www-data www-data -		d /var/log/daphne 0775 www-data www-data -
	}}		}}

	{{ hc \|/etc/tmpfiles.d/uwsgi.conf\|		{{ hc \|/etc/tmpfiles.d/uwsgi.conf\|
	d /run/uwsgi ~~0755~~ www-data www-data -		d /run/uwsgi 0775 www-data www-data -
	d /var/log/uwsgi ~~0755~~ www-data www-data -		d /var/log/uwsgi 0775 www-data www-data -
	}}		}}

Brodriguez: Correct example

2021-01-14T10:43:18Z

Correct example

← Older revision		Revision as of 10:43, 14 January 2021
Line 174:		Line 174:
	* If applicable, set up [[Programming/Nginx#Example 2: Redirecting Specific Requests \| request redirects]] for your project, where needed.		* If applicable, set up [[Programming/Nginx#Example 2: Redirecting Specific Requests \| request redirects]] for your project, where needed.
	* Define your core [[Programming/Nginx#Example 3: Passing Requests to UWSGI \| UWSGI request handler]], preferably via [[Programming/Nginx#Reusable Location Blocks \| reusable location blocks]].		* Define your core [[Programming/Nginx#Example 3: Passing Requests to UWSGI \| UWSGI request handler]], preferably via [[Programming/Nginx#Reusable Location Blocks \| reusable location blocks]].
	* Finally, if using something that needs websocket request handling (such as [https://channels.readthedocs.io/en/stable/ DjangoChannels], then we need an additional handler. The following code snippet passes requests to Daphne for DjangoChannels handling (this assumes websockets are all served under a root url of {{ ic \|/ws/}}):		* Finally, if using something that needs websocket request handling (such as [https://channels.readthedocs.io/en/stable/ DjangoChannels], then we need an additional handler. The following code snippet passes requests to Daphne for DjangoChannels handling (this assumes websockets are all served under a root url of {{ ic \|example.com/ws/}}):
	{{ hc \|/etc/nginx/sites-available/<project_name>.conf\|		{{ hc \|/etc/nginx/sites-available/<project_name>.conf\|
	<nowiki> # Send websocket connections to Daphne.		<nowiki> # Send websocket connections to Daphne.

Brodriguez: Update permission section

2021-01-14T03:27:33Z

Update permission section

← Older revision		Revision as of 03:27, 14 January 2021
Line 69:		Line 69:
	Permissions should be set such that both the expected user(s) and apache/nginx can access project files.		Permissions should be set such that both the expected user(s) and apache/nginx can access project files.

	~~If only one single~~ user ~~account~~ is ~~expected to access the project, then you should probably set folder/file permissions to~~ {{ ~~ic \|<username>:~~www-data}}.		Nginx seems to assume the user is {{www-data}}. You should probably also create a group that all users belong to. Thus we set folder/file permissions to {{ ic \|www-data:<group_name>}}.

	~~Alternatively, if multiple user accounts are expected to access the project, then you~~ should probably create a group that all users belong to. ~~Then~~ set folder/file permissions to {{ ic \|www-data:<group_name>}}.

	In both cases, you'll probably want to set permissions such that:		In both cases, you'll probably want to set permissions such that:
Line 83:		Line 81:
	* The local virtual environment		* The local virtual environment
	* Project logging folders		* Project logging folders
			* Any other files/folders that your website will need direct access to.

	For more details on permissions, see [[Linux/Permissions \| Linux Permissions]].		For more details on permissions, see [[Linux/Permissions \| Linux Permissions]].

Brodriguez: Update for new nginx page

2021-01-14T03:25:28Z

Update for new nginx page

@@ Line 166: / Line 166: @@
 === Nginx Configurations ===
-{{ todo | Create separate wiki section for general nginx syntax, which will significantly reduce size of this section and make it far more generic. }}
+There are many ways to setup a nginx server, with some basics located at [[Programming/Nginx]].
 {{ todo | Document making server more secure with possible SSL params. }}
-Create a snippet for our above SSL to pull from:
+Recommended steps for serving a Django project are as follows:
-{{ hc |/etc/nginx/snippets/ssl_certs.conf|
+* First, it's strongly recommended to [[Programming/Nginx#HTTPS and SSL | set up HTTPS]] and redirect all server traffic to HTTPS.
-<nowiki>ssl_certificate <ssl_certificate_location>;
+* Set up [[Programming/Nginx#Example 1: Serving static | static file handling]] for the {{ ic |/media}} and {{ ic |/static}} urls (or whatever the equivalent is for your specific Django project).
-ssl_certificate_key <ssl_certificate_key_location>;</nowiki>
+* If applicable, set up [[Programming/Nginx#Example 2: Redirecting Specific Requests | request redirects]] for your project, where needed.
-}}
+* Define your core [[Programming/Nginx#Example 3: Passing Requests to UWSGI | UWSGI request handler]], preferably via [[Programming/Nginx#Reusable Location Blocks | reusable location blocks]].
-Both lines should be changed to reflect the absolute path on the server for the SSL certificate, and SSL key, respectively.
+* Finally, if using something that needs websocket request handling (such as [https://channels.readthedocs.io/en/stable/ DjangoChannels], then we need an additional handler. The following code snippet passes requests to Daphne for DjangoChannels handling (this assumes websockets are all served under a root url of {{ ic |/ws/}}):
 {{ hc |/etc/nginx/sites-available/<project_name>.conf|
 <nowiki>    # Send websocket connections to Daphne.
@@ Line 241: / Line 191: @@
      }</nowiki>
 }}

Brodriguez: Correct a line

2020-12-08T15:26:30Z

Correct a line

← Older revision		Revision as of 15:26, 8 December 2020
Line 293:		Line 293:

	[Service]		[Service]
	ExecStart=/opt/env/<virtual_env_name>/bin/daphne -u /run/daphne/<project_name>.sock ~~settings~~.asgi:application		ExecStart=/opt/env/<virtual_env_name>/bin/daphne -u /run/daphne/<project_name>.sock <project_settings_folder>.asgi:application
	Restart=always		Restart=always
	Type=simple		Type=simple

Brodriguez: Add a line

2020-12-08T15:24:11Z

Add a line

← Older revision		Revision as of 15:24, 8 December 2020
Line 138:		Line 138:
	chdir = /srv/web_serve/django/%(project)		chdir = /srv/web_serve/django/%(project)
	home = /opt/env/<virtual_env_name>		home = /opt/env/<virtual_env_name>
	module = ~~settings~~.wsgi:application		module = <project_settings_folder>.wsgi:application


Line 160:		Line 160:
	* {{ ic \|<nowiki>project = <project_name></nowiki>}} (the second line) to match your project's root folder name.		* {{ ic \|<nowiki>project = <project_name></nowiki>}} (the second line) to match your project's root folder name.
	* {{ ic \|<nowiki>home = /opt/env/<virtual_env_name></nowiki>}} (the seventh line) to match your virtual environment location.		* {{ ic \|<nowiki>home = /opt/env/<virtual_env_name></nowiki>}} (the seventh line) to match your virtual environment location.
			* {{ ic \|<nowiki>module = <project_settings_folder>.wsgi:application</nowiki>}} (the eigth line) to match your project settings folder.
	* {{ ic \|<nowiki>wsgi-file = %(chdir)</nowiki>/settings/wsgi.py}} (5th to last line) to point to the actual uwsgi file in your project.		* {{ ic \|<nowiki>wsgi-file = %(chdir)</nowiki>/settings/wsgi.py}} (5th to last line) to point to the actual uwsgi file in your project.

Brodriguez: Further update commands

2020-12-08T15:21:44Z

Further update commands

← Older revision		Revision as of 15:21, 8 December 2020
Line 331:		Line 331:
	Once the files are created, tell the system to reload:		Once the files are created, tell the system to reload:
	sudo systemctl daemon-reload		sudo systemctl daemon-reload
	sudo systemctl ~~restart~~ daphne		sudo systemctl start daphne
	sudo systemctl ~~restart~~ uwsgi		sudo systemctl enable daphne
			sudo systemctl start uwsgi
			sudo systemctl enable uwsgi

	Check for possible errors with:		Check for possible errors with:

Brodriguez: Correct path

2020-12-08T15:17:20Z

Correct path

← Older revision		Revision as of 15:17, 8 December 2020
Line 228:		Line 228:
	<nowiki> # Send websocket connections to Daphne.		<nowiki> # Send websocket connections to Daphne.
	location /ws {		location /ws {
	proxy_pass http://unix:~~/var~~/run/daphne/<project_name>.sock;		proxy_pass http://unix:/run/daphne/<project_name>.sock;
	proxy_http_version 1.1;		proxy_http_version 1.1;
	proxy_set_header Upgrade $http_upgrade;		proxy_set_header Upgrade $http_upgrade;
Line 247:		Line 247:
	location @<project_name> {		location @<project_name> {
	include uwsgi_params;		include uwsgi_params;
	uwsgi_pass unix:~~/var~~/run/uwsgi/<project_name>.sock;		uwsgi_pass unix:/run/uwsgi/<project_name>.sock;
	}</nowiki>		}</nowiki>
	}}		}}

Brodriguez: Add a sentence

2020-12-08T14:07:56Z

Add a sentence

← Older revision		Revision as of 14:07, 8 December 2020
Line 337:		Line 337:
	journalctl -xe		journalctl -xe

	If no errors occur, then everything is good and your project is officially serving in production.		If no errors occur, then everything is good and your project is officially serving in production. Verify by trying to access your site in a browser.

Brodriguez: Update commands

2020-12-08T14:07:21Z

Update commands

← Older revision		Revision as of 14:07, 8 December 2020
Line 270:		Line 270:

	Once done, save config files and enable the config by creating a symlink from {{ ic \|/etc/nginx/sites-available/<project_name>.conf}} to {{ ic \|/etc/nginx/sites-enabled/<project_name>.conf}}:		Once done, save config files and enable the config by creating a symlink from {{ ic \|/etc/nginx/sites-available/<project_name>.conf}} to {{ ic \|/etc/nginx/sites-enabled/<project_name>.conf}}:
	ln -s /etc/nginx/sites-available/<project_name>.conf /etc/nginx/sites-enabled/<project_name>.conf		sudo ln -s /etc/nginx/sites-available/<project_name>.conf /etc/nginx/sites-enabled/<project_name>.conf

	Check for errors with:		Check for errors with:
Line 280:		Line 280:
	sudo systemctl restart nginx		sudo systemctl restart nginx

	~~At this point, if everything went well, then your project is now being served and can be accessed from a web browser.~~

	=== Systemd Service File Configurations ===		=== Systemd Service File Configurations ===
Line 332:		Line 331:
	Once the files are created, tell the system to reload:		Once the files are created, tell the system to reload:
	sudo systemctl daemon-reload		sudo systemctl daemon-reload
			sudo systemctl restart daphne
			sudo systemctl restart uwsgi

			Check for possible errors with:
			journalctl -xe

	If no errors occur, then everything is good and your project is officially serving in production.		If no errors occur, then everything is good and your project is officially serving in production.