Skip to content

Commit ca4b821

Browse files
authored
Clean up README.rst
1 parent ca9f946 commit ca4b821

File tree

1 file changed

+24
-30
lines changed

1 file changed

+24
-30
lines changed

README.rst

+24-30
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,25 @@
44
django CMS quickstart
55
#####################
66

7-
A dockerised django CMS project, ready to deploy on `Divio <https://www.divio.com/>`_ or another Docker-based cloud
8-
platform, and run locally in Docker on your own machine.
9-
10-
This version uses Python 3.11 and the most up-to-date versions of Django 4.2, and django CMS 4.1.0
11-
12-
This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_. That means that it
13-
is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy. Join us on
14-
`Slack <https://www.django-cms.org/slack/>`_ for more information or questions.
15-
16-
The documentation for version 4.1 can be found here: https://docs.django-cms.org/
7+
- A dockerised django CMS project intended to be run locally in Docker on your own machine or on a Docker-based cloud, such as `Divio <https://www.divio.com/>`_
8+
- This version uses Python 3.11 and the most up-to-date versions of Django 4.2, and django CMS 4.1.0
9+
- This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_. That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy. Join us on `Slack <https://www.django-cms.org/slack/>`_ for more information or questions.
10+
- The documentation for django CMS can be found here: https://docs.django-cms.org/
1711

1812
Installation
1913
############
2014

15+
Requirements
16+
============
17+
2118
You need to have Docker installed on your system to run this project.
2219

2320
- `Install Docker <https://docs.docker.com/engine/install/>`_ here.
2421
- If you have not used docker in the past, please read this
2522
`introduction on docker <https://docs.docker.com/get-started/>`_ here.
2623

27-
Try it
28-
######
24+
Local Setup
25+
===========
2926

3027
.. inclusion-marker-do-not-remove
3128
@@ -87,13 +84,18 @@ Features
8784
Static Files with Whitenoise
8885
============================
8986

90-
This quickstart demo has a cloud-ready static files setup via django-whitenoise.
87+
- This quickstart demo has a cloud-ready static files setup via django-whitenoise.
88+
- In the containerized cloud the application is not served by a web server like nginx but directly through uwsgi. django-whitenoise is the glue that's needed to serve static files in your application directly through uwsgi.
89+
- See the django-whitenoise settings in settings.py and the ``quickstart/templates/whitenoise-static-files-demo.html`` demo page template that serves a static file.
9190

92-
In the containerized cloud the application is not served by a web server like nginx but directly through uwsgi.
93-
django-whitenoise is the glue that's needed to serve static files in your application directly through uwsgi.
91+
Env variables
92+
=============
9493

95-
See the django-whitenoise settings in settings.py and the ``quickstart/templates/whitenoise-static-files-demo.html``
96-
demo page template that serves a static file.
94+
- By default, Docker injects the env vars defined in ``.env-local`` into the quickstart project.
95+
- If you want to access the PostgreSQL database from the host system, set ``DB_PORT`` to the desired port number.
96+
5432 is the standard port number. If you run PosgreSQL on your host system, you may want to set another port number.
97+
If this variable is empty (the default), the PosgreSQL instance in the container is only reachable within docker, but
98+
not from outside.
9799

98100
Contribution
99101
############
@@ -105,22 +107,14 @@ Here is the official django CMS repository:
105107
Deployment
106108
##########
107109

108-
Note that this is just a demo project to get you started. If you want a full production ready site with all the bells
110+
Note that this is just a demo project to get you started. It is designed to be run locally through docker. If you want a full production ready site with all the bells
109111
and whistles we recommend you have a look at https://github.com/django-cms/djangocms-template instead.
110112

111-
Env variables
112-
=============
113-
114-
- to deploy this project in testing mode (recommended) set the environment variable ``DEBUG`` to ``True`` in your
115-
hosting environment.
116-
- For production environment (if ``DEBUG`` is false) django requires you to whitelist the domain. Set the env var
117-
``DOMAIN`` to the host, i.e. ``www.domain.com`` or ``*.domain.com``.
118-
- If you want the media hosted on S3 set the ``DEFAULT_FILE_STORAGE`` variable accordingly.
119-
- If you want to access the PostgreSQL database from the host system, set ``DB_PORT`` to the desired port number.
120-
5432 is the standard port number. If you run PosgreSQL on your host system, you may want to set another port number.
121-
If this variable is empty (the default), the PosgreSQL instance in the container is only reachable within docker, but
122-
not from outside.
113+
Some deployment hints:
123114

115+
- To deploy this project in testing mode (recommended) set the environment variable ``DEBUG`` to ``True`` in your hosting environment.
116+
- Be aware that if ``DEBUG`` is false, django requires you to whitelist the domain. Set the env var ``DOMAIN`` to the host, i.e. ``www.domain.com`` or ``*.domain.com``.
117+
- You can set the env var ``DEFAULT_STORAGE_DSN`` to something meaningful (i.e. for s3 file storage)
124118

125119
Deployment Commands
126120
===================

0 commit comments

Comments
 (0)