You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: etc/docker/README.md
+36-33Lines changed: 36 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
# How to install Superdesk and Publisher with Docker
2
2
3
-
This guide explains how to install complete Superdesk digital publishing system made of Superdesk headless CMS (with the Publisher plugin) and the Publisher, using Docker.
3
+
This guide explains how to install a complete Superdesk digital publishing system made of Superdesk headless CMS (with the Publisher plugin) and the Publisher, using Docker.
4
4
5
5
## Prerequisites
6
6
7
-
For using Superdesk and Publisher tohetger, the following line must be added the to `hosts` file on local machine, if it doesn't exist:
7
+
For using Superdesk and Publisher together, the following line must be added the to the `hosts` file on the local machine, if it doesn't exist:
8
8
9
9
```
10
10
127.0.0.1 superdesk.local publisher.local
11
11
```
12
12
13
13
14
-
Both ```superdesk.local``` and ```publisher.local``` are configured as aliases for appropriate Superdesk and Publisher containers.
14
+
Both ```superdesk.local``` and ```publisher.local``` are configured as aliases for respective Superdesk and Publisher containers.
15
15
16
-
Before continuing, Docker network should be set, if it doesn't exist:
16
+
Before continuing, the Docker network should be set, if it doesn't exist:
Start superdesk using the ```docker-compose.yml``` file:
113
+
Start Superdesk using the ```docker-compose.yml``` file:
114
114
115
115
```bash
116
116
docker-compose up -d
@@ -122,15 +122,22 @@ Finish Superdesk setup:
122
122
docker-compose run superdesk-server /opt/superdesk/docker/start.sh
123
123
```
124
124
125
+
After the first start, the Superdesk gets populated with the demo data, which is generally a good idea. However, reinserting demo data will create problems, so after the first ```docker-compose up -d``` run, change the ```DEMO_DATA``` environment variable in ```docker-compose.yml``` to ```0``` for the ```superdesk-server``` container:
126
+
127
+
```
128
+
- DEMO_DATA=0
129
+
```
130
+
131
+
125
132
### Post installation
126
133
127
134
This will install Superdesk with the Publisher plugin and make it available at [superdesk.local:8080](http://superdesk.local:8080).
128
135
129
-
In order to have it talk to the Publisher, attach to ```superdesk-sp_superdesk-client_1``` container and edit `config.random.js` (ie config.ec23ae24.js).
136
+
To have it talk to the Publisher, attach to ```superdesk-sp_superdesk-client_1``` container and edit `config.random.js` (ie config.ec23ae24.js).
After the first start, Superdesk is being populated with demo data, which is generally good idea. However, reinserting demo data will create problems, so after the first ```docker-compose up -d``` run, change demo data environment variable in ```docker-compose.yml``` to ```0``` for the ```superdesk-server``` container:
165
-
166
-
```
167
-
- DEMO_DATA=0
168
-
```
169
+
This concludes the Superdesk installation and setup, and the Publisher connection. As the Publisher is not yet installed and configured, it won't be available in Superdesk, if you try looking for it at this point. The steps for installing the Publisher are below.
169
170
170
171
171
172
## Publisher
@@ -175,7 +176,7 @@ If you are still in the `superdesk-sp` directory, go one step up
175
176
cd ..
176
177
```
177
178
178
-
Clone Publisher repository and move into the `etc/docker` directory
179
+
Clone the Publisher repository and move into the `etc/docker` directory
@@ -190,7 +191,7 @@ Copy `.env.example` to `.env`:
190
191
cp .env.example .env
191
192
```
192
193
193
-
`.env.example` file contains environment variable for having Publisher available at [publisher.local](http://publisher.local), and connected to Superdesk at [superdesk.local:8080](http://superdesk.local:8080) (available in superdesk-client Docker container).
194
+
`.env.example` file contains an environment variable for having the Publisher available at [publisher.local](http://publisher.local), and connected to Superdesk at [superdesk.local:8080](http://superdesk.local:8080) (available in superdesk-client Docker container).
194
195
195
196
Copy `.docker-compose.yml.example` to `.docker-compose.yml.`
196
197
@@ -228,11 +229,11 @@ docker-compose run php php bin/console doctrine:database:create
228
229
docker-compose run php php bin/console doctrine:migrations:migrate --no-interaction
229
230
```
230
231
231
-
### Tenants and organisation
232
+
### Tenants and organization
232
233
233
-
There are two options:
234
-
* Load tenants and organization sample data fixtures
235
-
*Setup the tenant manually
234
+
There are two options for creating organization and tenants:
235
+
* Load sample data fixtures
236
+
*Manual setup
236
237
237
238
#### Load tenants and organization sample data with fixtures
238
239
@@ -253,7 +254,7 @@ docker-compose run php php bin/console sylius:theme:assets:install
Go to http://publisher.localfor viewing the app in dev mode.
315
+
Go to http://publisher.localto view the app in dev mode.
315
316
316
-
### Configure (optional)
317
+
### Optional configuration
317
318
318
319
If you use Docker for Windows, you might need to additionally
319
-
change the values of `SWP_DOMAIN` and `CACHE_SERVERS` env vars from `localhost` to `127.0.0.1` in `.env` file.
320
+
change the values of `SWP_DOMAIN` and `CACHE_SERVERS` env vars from `localhost` to `127.0.0.1` in the `.env` file.
320
321
321
322
### Where to see nginx logs?
322
323
@@ -328,9 +329,11 @@ change the values of `SWP_DOMAIN` and `CACHE_SERVERS` env vars from `localhost`
328
329
329
330
## Setting up Superdesk to talk to Publisher
330
331
331
-
After successfully finishing both installations, there are additional steps in order to have articles being published from Superdesk to Publisher.
332
+
After successfully finishing both installations, there are additional steps to have articles published from the Superdesk to the Publisher.
333
+
334
+
First of all, check if the Superdesk and Publisher are talking to each other, assuming that the Publisher is installed and available at [publisher.local](http://publisher.local): go to the hamburger menu in the upper left corner of the Superdesk interface, and choose Publisher Settings.
332
335
333
-
First of all, check if Superdesk and Publisher are talking to each other, assuming that the Publisher is installed and available at [publisher.local](http://publisher.local): go to the hamburger menu in the upper left corner, and choose Publisher Settings, Publisher tenant(s) should be listed.
https://www.youtube.com/watch?v=wjsVBM88IRg (**this video uses the older version with publisher.local:8080, use publisher.local instead**)
350
353
351
-
### Create “catch all” publishing rule
354
+
### Create a “catch all” publishing rule
352
355
353
-
After the content is sent to Publisher’s subscriber, Publisher needs a generic rule to “catch” and publish it. Therefore one “catch all” rule should be created.
356
+
After the content is sent to the Publisher’s subscriber, the Publisher needs a generic rule to “catch” and publish it. Therefore one “catch all” rule should be created.
354
357
355
-
In *[Publisher Settings](http://superdesk.local:8080/#/publisher/settings)* (available in the Superdesk "hamburger" menu) choose *Publishing Rules* from the left pane, click *Add new* and choose *Organizational rule*. Name it *catch-all*, switch on *Catch all* toggle, click + button under *Destination (Tenants)*, choose your tenant and click *Save*.
358
+
In *[Publisher Settings](http://superdesk.local:8080/#/publisher/settings)* (available in the Superdesk "hamburger" menu) choose *Publishing Rules* from the left pane, click *Add new* and choose *Organizational rule*. Name it *catch-all*, switch on *Catch all* toggle, click + button under *Destination (Tenants)*, choose your tenant, and click *Save*.
356
359
357
360
358
361
### Create and publish an article
359
362
360
363
https://www.youtube.com/watch?v=UDCZdEfGfHI
361
364
362
-
This process can be automated by creating publishing rules with category targeting (specific category publishes to specific route). Article flow from Superdesk to Publisher can be monitored in the Publisher Output Control.
365
+
This process can be automated by creating publishing rules with category targeting (specific category publishes to the specific route). Article flow from Superdesk to Publisher can be monitored in the Publisher Output Control.
0 commit comments