A CMS optimized for low consumption
Project description
Goal
A fully functional CMS optimized for low consumption.
Read blog posts about this.
Benchmark
Description
ColdCMS is a Django project based on Wagtail CMS and Bulma CSS framework.
The admin can edit websites through an intuitive and user-friendly interface. Different types of pages are pre-designed, making it possible to have a nice-looking website without spending hours on it.
ColdCMS is especially designed for people who want to reduce the impact of their use of digital technologies on the environnement.
The client website consists of static pages, built with Wagtail bakery. The website pages are generated and updated when necessary (e.g. when the admin publishes or modifies content).
Among other optimizations, the size of CSS files is reduced and unused CSS code is removed, using PurgeCSS and clean-css.
ColdCMS supports Python >= 3.6.
How to use ColdCMS?
You have access to a ColdCMS instance and you want to create a website:
You can find the user documentation here:
You want to install ColdCMS:
You have two options: docker installation or manual installation.
Docker installation
You will need docker-compose and docker with a running daemon.
We provide a sample docker/docker-compose.yml file. Feel free to modify it for your needs.
cd docker && docker-compose upHere are some env variables that you might want to change:
POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB see https://github.com/docker-library/docs/blob/master/postgres/README.md#environment-variables
DB_URL, the database connection URL, see https://github.com/jacobian/dj-database-url#url-schema
SECRET_KEY, the Django secret key, it should be a private, 40-character long randomly-generated string
You can then create an admin user which will have access to http://localhost/admin
docker exec -it docker_backend_1 python3 manage.py createsuperuserManual installation
(This has only been tested on Linux environments.)
Install ColdCMS with pypi:
pip install coldcmsRun the quick launch command:
python -m coldcmsBefore this command you can set the following environment variables :
RUN_DJANGO_MIGRATION=0: do not run the migrations
SETUP_INITIAL_DATA=0: do not setup the initial data, in case you want to keep the data you already have in your coldcms database
COLLECT_STATIC=0: do not collect the static files. Don’t set that variable to 0 if it is your first time launching ColdCMS.
CREATE_SUPERUSER=0: do not create a new superuser (you can have several superuser at a time, but not with the same username or email)
BUILD_ASSETS=0: do not build build assets. Don’t set that variable to 0 if it is your first time launching ColdCMS.
BUILD_STATIC=0: do not build static files. Don’t set that variable to 0 if you’ve also set SETUP_INITIAL_DATA to 0.
Example : CREATE_SUPERUSER=0 python -m coldcms will run the migrations, setup some new initial data, but will not create a new superuser.
You are a developer and you want to contribute to ColdCMS
Clone the gitlab repository, and read the Dev section below to install the ColdCMS development environment.
Follow the contribution guidelines.
Dev
(This has only been tested on Linux environments.)
1. Install the dependencies
Install libjpeg and zlib, needed to work with images through the Pillow library. If you have a debian-based distribution, use the following commands:
sudo apt-get install zlib1g-dev
sudo apt-get install libjpeg-devAlso, please install PurgeCSS and clean-css, to reduce the size of CSS files:
npm install -g purgecss@2.1.0 clean-css-cli@4.3.0And to continue with javascript, please install static dependencies :
(cd coldcms/static/ && npm i --save-dev)We use sass to transpile sass files to CSS. Make sure that the binary sass from the sassc package is present in your $PATH. In debian-based distributions, run the following:
sudo apt-get install sasscFinally, run:
pip install -r requirements_dev.txt2. Create a database
By default, ./manage.py migrate will create a sqlite3 database named coldcms.
If you want to use a different database engine, you can specify it in the environment variable DB_URL. Make sure you have the proper database driver for the engine you want to use.
If you want to use a different name for your sqlite database, you can specify it in the environment variable DB_NAME (useless for some engines as it is directly specified in the url - see table below).
As advised in the django documentation, if you’re new to databases, or you’re just interested in trying ColdCMS, use the default sqlite3 database, it is included in Python, so you won’t need to install anything else to support your database. When starting your first real project, however, you may want to use a more scalable database like PostgreSQL, to avoid database-switching headaches down the road.
Engine |
DB_URL |
|---|---|
PostgreSQL |
postgres://USER:PASSWORD@HOST:PORT/NAME |
PostGIS |
postgis://USER:PASSWORD@HOST:PORT/NAME |
MSSQL |
mssql://USER:PASSWORD@HOST:PORT/NAME |
MySQL |
mysql://USER:PASSWORD@HOST:PORT/NAME |
MySQL (GIS) |
mysqlgis://USER:PASSWORD@HOST:PORT/NAME |
SQLite |
sqlite:///PATH |
SpatiaLite |
spatialite:///PATH |
Oracle |
oracle://USER:PASSWORD@HOST:PORT/NAME |
Oracle (GIS) |
oraclegis://USER:PASSWORD@HOST:PORT/NAME |
Redshift |
redshift://USER:PASSWORD@HOST:PORT/NAME |
Replace PATH, USER, PASSWORD, HOST, PORT and NAME with the correct values.
For example, if you want to use PostgreSQL :
systemctl status postgresql # make sure postgresql is running
createdb coldcms # create the coldcms postgres database
sudo -u postgres psql
CREATE USER username PASSWORD 'password';
ALTER ROLE username WITH SUPERUSER;
\q
export DB_URL="postgres://username:password@localhost:5432/coldcms"3. Launch the development server
./manage.py migrate
./manage.py collectstatic
./manage.py compilemessages
./manage.py createsuperuser
./manage.py setup_initial_data # optional - loads data of a basic home page
./manage.py runserverRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
