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: README.md
+3-64Lines changed: 3 additions & 64 deletions
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,8 @@ In case we don't want to operate the delivery tier ourselves and instead use a C
26
26
For the content management tier we provide two submodules which together with a queue handle the propagation of content change events:
27
27
28
28
1.[Paperboy push service](./paperboy-push-service): A small HTTP service that can be used as a webhook.
29
-
2.[Paperboy Magnolia module](./paperboy-magolia-module): A module that integrates directly into Magnolia and sends HTTP messages to the push service (or an arbitrary webhook) whenever a change in a watched workspace occurs.
30
29
31
-
The subscriber part of this system is currently comprised of three submodules in this repository:
30
+
The subscriber part of this system is currently comprised of two submodules in this repository:
32
31
33
32
1.[Paperboy Core](./paperboy-core): The core library which handles all generic configuration and knows how to execute the commands to trigger rebuilds.
34
33
2.[Paperboy CLI](./paperboy-cli): A simple CLI to ease usage and setup
To get started with your project, execute the stepts in [Frontend Set-Up](#frontend-set-up) and [Magnolia Set-Up](#magnolia-set-up). Afterwards either execute the steps from [Custom delivery layer](#custom-delivery-layer) or [Netlify](#netlify) depending on your setup.
57
-
58
-
### Frontend Set-Up
53
+
### Set-Up
59
54
60
55
To use Paperboy in your Frontend you can simply install the CLI globally via:
61
56
@@ -69,44 +64,12 @@ In case that you are writing the frontend with JavaScript you can also install t
69
64
$ npm i --save-dev @neoskop/paperboy-cli
70
65
```
71
66
72
-
### Magnolia Set-Up
73
-
74
-
Generate a blank Magnolia project using Magnolia's archetype catalog:
Afterwards add the Paperboy Magnolia Module to the webapp's POM.xml:
82
-
83
-
```xml
84
-
<dependency>
85
-
<groupId>de.neoskop.magnolia</groupId>
86
-
<artifactId>paperboy</artifactId>
87
-
<version>2.0.0</version>
88
-
</dependency>
89
-
```
90
-
91
-
Build the WAR and deploy it in a servlet container.
92
-
93
-
### Custom delivery layer
94
-
95
-
In case of a custom deliver layer, start the push service and a NATS server by running the following command in the root folder of this repository:
67
+
Start the push service and a NATS server by running the following command in the root folder of this repository:
96
68
97
69
```bash
98
70
$ docker-compose up
99
71
```
100
72
101
-
When the containers are up and running, import the following config into Magnolia's configuration under `/modules/paperboy/config`:
102
-
103
-
```yaml
104
-
webhookConfig:
105
-
authorization: BEARER_TOKEN
106
-
bearerToken: supersecret
107
-
url: http://push-service:8080/
108
-
```
109
-
110
73
To configure the frontend, create a file called `paperboy.config.json` with the following contents:
111
74
112
75
```json
@@ -124,30 +87,6 @@ Finally change to the frontend directory and run:
124
87
$ paperboy start
125
88
```
126
89
127
-
### Netlify
128
-
129
-
To trigger a rebuild of the frontend whenever a change in Magnolia's content occurs, create a webhook in Netlify under `Settings > Build & Deploy` in your project.
130
-
131
-
Click "Add build hook":
132
-
133
-

134
-
135
-
Give the hook a meaningful name and press "Save":
136
-
137
-

138
-
139
-
Copy the webhook's URL:
140
-
141
-

142
-
143
-
Finally import the following config into Magnolia's configuration under `/modules/paperboy/config`:
0 commit comments