collectstatic for production in Django - Step-by-Step Execution

Concept Flow - collectstatic for production

Run collectstatic command

↓

Find all static files in apps and static folders

↓

Copy static files to STATIC_ROOT folder

↓

Static files ready for production server

↓

Production server serves static files from STATIC_ROOT

This flow shows how Django collects all static files from your project and apps, then copies them into one folder for production use.

Execution Sample

Django

python manage.py collectstatic
# Copies all static files to STATIC_ROOT

This command gathers all static files into one folder for the production server to serve.

Execution Table

Step	Action	Source Folder	Destination Folder	Files Copied	Notes
1	Start collectstatic	-	-	-	Command initiated
2	Scan app static folders	app1/static/	STATIC_ROOT/	style.css, logo.png	Found files in app1
3	Scan app static folders	app2/static/	STATIC_ROOT/	script.js	Found files in app2
4	Scan project static folder	project/static/	STATIC_ROOT/	main.css	Found project-level static files
5	Copy files to STATIC_ROOT	-	STATIC_ROOT/	style.css, logo.png, script.js, main.css	All files copied
6	Finish collectstatic	-	-	-	Static files ready for production

💡 All static files copied to STATIC_ROOT, ready for production server

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
Files Found	[]	[style.css, logo.png]	[style.css, logo.png, script.js]	[style.css, logo.png, script.js, main.css]	[style.css, logo.png, script.js, main.css]
Files Copied	[]	[]	[]	[]	[style.css, logo.png, script.js, main.css]

Key Moments - 2 Insights

Why do we need to run collectstatic before production?

Because Django does not serve static files itself in production, collectstatic gathers all static files into one folder (STATIC_ROOT) so the production server can serve them efficiently. See execution_table step 6.

What happens if two apps have files with the same name?

The last copied file will overwrite the previous one in STATIC_ROOT. This is why unique file names or folder structures are important. This is implied in execution_table step 5 where files are copied.

Visual Quiz - 3 Questions

Look at the execution_table, after which step are all static files found?

A After Step 2

B After Step 3

C After Step 4

D After Step 5

💡 Hint

Check the 'Files Found' variable in variable_tracker after each step.

At which step are the static files actually copied to STATIC_ROOT?

A Step 5

B Step 4

C Step 2

D Step 6

💡 Hint

Look at the 'Files Copied' column in execution_table.

If a new app with static files is added, how would the execution_table change?

A Files would be copied before scanning.

B A new scanning step for the app's static folder would be added before copying.

C No change, files are copied automatically without scanning.

D The command would fail.

💡 Hint

Refer to the scanning steps 2-4 in execution_table.

Concept Snapshot

Django collectstatic command:
- Gathers all static files from apps and project
- Copies them into STATIC_ROOT folder
- Prepares static files for production server
- Run with: python manage.py collectstatic
- Ensures production server can serve static files efficiently

Full Transcript

The collectstatic command in Django is used to gather all static files from your apps and project static folders. When you run 'python manage.py collectstatic', Django scans each app's static folder and the project static folder, finds all static files like CSS, JavaScript, and images, and copies them into a single folder called STATIC_ROOT. This folder is then used by the production server to serve static files efficiently. The process involves scanning, collecting, and copying files step-by-step. This is important because Django does not serve static files by itself in production. If two files have the same name, the last copied file will overwrite the previous one, so unique naming is important. Adding a new app with static files will add a new scanning step before copying. This command prepares your static files for production use.

Practice

1. What is the main purpose of running collectstatic in a Django project before deployment?

easy

A. To gather all static files into one folder for easy serving in production

B. To compile Python code into bytecode

C. To migrate database changes

D. To start the Django development server

Solution

1. Step 1: Understand what collectstatic does

   The collectstatic command collects all static files from apps and places them into a single directory.

2. Step 2: Recognize its role in production

   This makes it easier for the web server to serve static files efficiently in production environments.

3. Final Answer:

   To gather all static files into one folder for easy serving in production -> Option A

4. Quick Check:

   collectstatic gathers static files [OK]

Hint: Remember: collectstatic collects static files for production [OK]

Common Mistakes:

• Confusing collectstatic with database migrations
• Thinking collectstatic runs the server
• Assuming collectstatic compiles Python code

2. Which setting must be defined in settings.py to specify where collectstatic will gather static files?

easy

A. STATIC_ROOT

B. MEDIA_ROOT

C. STATIC_URL

D. STATICFILES_DIRS

Solution

1. Step 1: Identify the setting for static file collection

   STATIC_ROOT tells Django the directory where collected static files will be placed.

2. Step 2: Differentiate from other static settings

   STATIC_URL is the URL prefix, MEDIA_ROOT is for user-uploaded files, and STATICFILES_DIRS lists additional static file locations.

3. Final Answer:

   STATIC_ROOT -> Option A

4. Quick Check:

   STATIC_ROOT sets collection folder [OK]

Hint: STATIC_ROOT is the folder for collected static files [OK]

Common Mistakes:

• Confusing STATIC_ROOT with STATIC_URL
• Using MEDIA_ROOT for static files
• Thinking STATICFILES_DIRS is the collection folder

3. Given the following settings.py snippet:

STATIC_URL = '/static/'
STATIC_ROOT = '/var/www/example.com/static/'
STATICFILES_DIRS = ['/home/user/project/assets']

What happens when you run python manage.py collectstatic?

medium

A. Static files are deleted from /var/www/example.com/static/

B. Static files remain in /home/user/project/assets and are not copied

C. Static files from assets and app static folders are copied to /var/www/example.com/static/

D. An error occurs because STATIC_URL is not a valid path

Solution

1. Step 1: Understand the role of STATICFILES_DIRS and STATIC_ROOT

   STATICFILES_DIRS lists extra folders with static files, and STATIC_ROOT is the destination for collected files.

2. Step 2: What collectstatic does

   Running collectstatic copies all static files from app static folders and STATICFILES_DIRS into STATIC_ROOT.

3. Final Answer:

   Static files from assets and app static folders are copied to /var/www/example.com/static/ -> Option C

4. Quick Check:

   collectstatic copies files to STATIC_ROOT [OK]

Hint: collectstatic copies all static files to STATIC_ROOT [OK]

Common Mistakes:

• Thinking STATIC_URL affects file copying
• Believing files stay in source folders
• Assuming collectstatic deletes files

4. You run python manage.py collectstatic but get an error: Permission denied for the STATIC_ROOT directory. What is the best way to fix this?

medium

A. Remove the STATIC_ROOT setting from settings.py

B. Change permissions of the STATIC_ROOT folder to allow write access

C. Run collectstatic without any arguments

D. Delete all static files from your apps

Solution

1. Step 1: Understand the error cause

   The Permission denied error means Django cannot write files to the STATIC_ROOT folder due to OS permissions.

2. Step 2: Fix permissions

   Changing the folder permissions to allow write access for the user running the command resolves this issue.

3. Final Answer:

   Change permissions of the STATIC_ROOT folder to allow write access -> Option B

4. Quick Check:

   Fix permissions to allow writing [OK]

Hint: Fix folder permissions to allow writing [OK]

Common Mistakes:

• Removing STATIC_ROOT disables static collection
• Running collectstatic without fixing permissions
• Deleting static files unnecessarily

5. You want to deploy your Django project to production. Your settings.py has:

STATIC_URL = '/static/'
STATIC_ROOT = '/var/www/example.com/static/'
STATICFILES_DIRS = ['/home/user/project/assets']

After running collectstatic, you notice some static files are missing from /var/www/example.com/static/. What could be a reason and how to fix it?

hard

A. Static files are not copied if DEBUG is True; set DEBUG to False

B. You forgot to set STATIC_URL to the correct path

C. You need to run python manage.py migrate before collectstatic

D. Some static files are inside app folders but not declared in STATICFILES_DIRS; add app static folders or check AppConfig

Solution

1. Step 1: Understand where static files come from

   Django collects static files from app static folders and STATICFILES_DIRS. If files are missing, they might be in app folders not properly recognized.

2. Step 2: Fix by ensuring app static folders are included

   Check that apps have static folders and are correctly configured. Adding missing folders to STATICFILES_DIRS or verifying app configs helps.

3. Final Answer:

   Some static files are inside app folders but not declared in STATICFILES_DIRS; add app static folders or check AppConfig -> Option D

4. Quick Check:

   Missing files often mean missing source folders [OK]

Hint: Check all static source folders are included [OK]

Common Mistakes:

• Thinking STATIC_URL affects file copying
• Running migrate instead of collectstatic
• Assuming DEBUG controls static file copying