Prepare Docker env

MacOS:

screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
sysctl -w vm.max_map_count=262144
(to exit Ctrl + a + d)

Quick Start

There’s in place a convenience Makefile that setups all the basic enviroment required for Guillotina CMS to work:

make

It will install the default venv, pull and launch the docker containers, and setup the default objects in the DB for the CMS to work. If you do this, you can pass on the next steps. Follow the next steps in case you want to have more control over how the environment is set up.

You can always run:

make initdb

to delete the DB. You can run:

make deletedb

to reset and remove the default container.

Start Docker Background

Start it (with postgres)

docker-compose create
docker-compose -f docker-compose.yaml up postgres redis

Build dev image (a.k.a. ./bin/buildout)

To install with docker:

docker-compose build guillotina

To install with virtualenv (python 3.7)

virtualenv .
source bin/activate
pip install -r requirements.txt
pip install -e .[test]

Run dev (a.k.a. ./bin/instance fg)

Run docker dev container (with cockroach)

docker-compose run --service-ports guillotina

Run docker dev container (with postgres)

docker-compose -f docker-compose.yaml run --service-ports guillotina

Run on virtualenv (with postgres)

g -c config.yaml

Add CMS container

Add CMS containers:

curl -X POST --user root:root http://localhost:8081/db -d '{"@type": "Container", "id": "web", "title": "Plone Site"}'
curl -X POST --user root:root http://localhost:8081/db/web/@addons -d '{"id": "cms"}'

Using Executioner (optional)

If you want to access and browse the guillotina tree you can use the Angular Front:

http://localhost:8081/+admin

Running Volto

First, install Volo: https://github.com/plone/volto

Then edit “src/config/index.js” to change the default Plone backend parameter RAZZLE_API_PATH:

apiPath: process.env.RAZZLE_API_PATH || 'http://localhost:8081/db/web

then start the server in development mode:

$ yarn start

or alternativelly, setup the environment variable to modify it:

$ RAZZLE_API_PATH=http://localhost:8081/db/web yarn start

Then go to http://localhost:3000 to see the Volto frontend running on Guillotina!

You can log into Volto with username “root” and password “root”.

If you are interested in start a Volto project instead of developing Volto, you can follow the instructions in:

https://docs.voltocms.com/01-getting-started/01-install/#install-volto

Cleanup DB

Cleanup postgres env:

docker-compose -f docker-compose.yaml rm -s -v postgres

Optional addons

• guillotina_linkintegrity

(with link integrity you’ll also need redis)

With Extras

Install guillotina_cms with pip install guillotina_cms[extras]

Which enabled elasticsearch full text search, pubsub and link integrity support.

Run docker with elasticsearch and redis:

docker-compose -f docker-compose.yaml rm -s -v redis postgres elasticsearch

Uncomment guillotina_elasticsearch from applications list in config.yaml:

- guillotina_elasticsearch
- guillotina_linkintegrity

5.0.0a1 (2019-06-22)

• fix link integrity tests

• upgrade to guillotina > 5

1.0a23 (unreleased)

• A naive fieldset order [ramon]

• Add Makefile and assosciated helper scripts for initialize the DB and install CMS required packages [sneridagh]

• Fix local development G enviroment config [sneridagh]

• Fix breadcrumbs initial object [sneridagh]

1.0a22 (2019-04-26)

• bump again

1.0a22 (2019-04-26)

• Another fix for latest

1.0a21 (2019-04-26)

• Fixes with latest guillotina

1.0a20 (2019-02-05)

• improve plone compatible search parser [vangheem]

1.0a19 (2019-01-31)

• Do elasticsearch queries with retrieving data against reverse indexes and not the original doc [vangheem]

• Store more fields for es lookup [vangheem]

1.0a18 (2019-01-31)

• Implement content ordering [vangheem]

1.0a17 (2018-12-19)

• Handle issue when detected id is empty string [vangheem]

1.0a16 (2018-12-06)

• Fix release

1.0a15 (2018-12-06)

• Fix id generation to produce valid ids [vangheem]

1.0a14 (2018-11-21)

• Upgrade to work with guillotina >= 4.3.0

1.0a13 (2018-11-09)

• Update guillotina [bloodbare]

1.0a12 (2018-11-05)

• Content layout support [bloodbare]

1.0a11 (2018-10-23)

• News has a text field [bloodbare]

• Be able to provide initial state when creating object [vangheem]

• Fix image scaling [vangheem]

• Provide file download url in file type response [vangheem]

1.0a10 (2018-10-02)

• Split search function to call it from other code [bloodbare]

• Adding a base chart helm configuration [bloodbare]

• Updating guillotina [bloodbare]

• Fix image deserialization error [vangheem]

1.0a9 (2018-09-28)

• Fixing navigation to use @search endpoint and get parameter to get navigation based on depth [bloodbare]

• Full object search result [bloodbare]

• Setting default title for an object the id of itself [bloodbare]

1.0a8 (2018-09-27)

• Use application setting dependencies [vangheem]

1.0a7 (2018-09-27)

• Provide scale for Images and ImageField [bloodbare]

• Add guillotina_linkintegrity [vangheem]

• Syndication settings behavior(ssr needs to provide feeds) [vangheem]

• Provide image scale support [vangheem]

1.0a6 (2018-09-26)

• Fixing constraints api [bloodbare]

1.0a5 (2018-09-25)

• Remove login endpoint [bloodbare]

1.0a4 (2018-09-19)

• Adding fieldset directive [bloodbare]

1.0a3 (2018-09-16)

• Adding constraints endpoint [bloodbare]

• Adding News content type [bloodbare]

• Initial Workflow implementation [bloodbare]

• File Content type [bloodbare]

• Cookie authentication [bloodbare]

• Id on images based on filename [bloodbare]

• Image content type [bloodbare]

1.0a2 (2018-08-01)

• Fix dependencies for pip install [bloodbare]

1.0a1 (2018-07-30)

• Initial release with search, tiles, websocket pubsub and basic content [bloodbare, jordic, vangheem]