Skip to content

Commit 2dee5b3

Browse files
updated documentation
1 parent 6d2ce41 commit 2dee5b3

11 files changed

+62
-11
lines changed

Readme.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ Welcome to Concorda wiki. Please choose your topic below.
1010

1111
**[Deployment types](./doc/deployment-types.md)**
1212

13-
- [Deploy only Concorda microservice](./doc/install-microservice.md)
14-
- [Deploy Concorda as standalone server](./doc/install-monolith.md)
15-
- [Deploy Concorda-Dashboard with Concorda running as microservice](./doc/install-concorda-microservice.md)
13+
- [Deploy only Concorda microservice](./doc/deploy-microservice.md)
14+
- [Deploy as a Seneca plugin](./doc/deploy-plugin.md)
15+
- [Deploy Concorda as standalone server](./doc/deploy-monolith.md)
16+
- [Deploy Concorda-Dashboard with Concorda running as microservice](./doc/deploy-concorda-microservice.md)
1617

1718
**[Installing the Client](./doc/install-client.md)**
1819

File renamed without changes.
File renamed without changes.

doc/deploy-plugin.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Back to [TOC](../Readme.md)
2+
3+
# Deploy as a Seneca plugin
4+
5+
Note: Even if Concorda microservice is offering all required services for client authentication, in order to fully use the
6+
Concorda's features (includes user management, runtime configurations and others) you can use also Concorda Administration Dashboard,
7+
that can be installed and started as a separate application.
8+
9+
## Installing and running Concorda as internal Seneca plugin
10+
11+
Install Concorda module in your application
12+
13+
```
14+
npm install --save concorda
15+
```
16+
17+
then
18+
19+
```
20+
const Concorda = require('concorda')
21+
22+
module.exports = function (options) {
23+
var seneca = this
24+
25+
seneca
26+
.use(Concorda, {
27+
.....options.....
28+
})
29+
30+
return {
31+
name: 'your-plugin'
32+
}
33+
}
34+
35+
```
36+
37+
38+
IMPORTANT NOTES
39+
===============
40+
41+
1. By default the following user is added to Concorda as part of initial setup: [email protected]/concorda
42+
2. It is very important that after you started Concorda for the first time to login and change administrator password and e-mail.

doc/deployment-types.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,35 @@ Back to [TOC](../Readme.md)
22

33
# Deployment types
44

5-
Concorda can be installed in many types. Bellow are presented these deployment types.
5+
Concorda can be installed in many ways. Bellow are presented these deployment types.
66

77
## Standalone server
88

9-
The project is installed and is starting as a monolith, no additional micro-services necessary.
10-
Please take a look on this [page](./install-monolith.md) for details.
9+
The project is installed and started as a monolith application.
10+
Please take a look on this [page](./deploy-monolith.md) for details.
1111

12-
![Diagram](https://github.com/Concorda/docs/blob/master/img/monolith.jpeg)
12+
![Diagram](https://github.com/Concorda/docs/blob/master/img/deploy-monolith.jpeg)
1313

1414
## Separate Administration Dashboard and microservice
1515

1616
There will be a separate server for Administration Dashboard and separate core microservice.
17-
Please take a look on this [page](./install-dashboard-and-microservice.md) for details.
17+
Please take a look on this [page](./deploy-dashboard-and-microservice.md) for details.
1818

19-
![Diagram](https://github.com/Concorda/docs/blob/master/img/concorda-microservice.jpeg)
19+
![Diagram](https://github.com/Concorda/docs/blob/master/img/deploy-concorda-microservice.jpeg)
2020

2121
## Just Concorda microservice
2222

2323
There can be used just the microservice. In some cases the deployment can contain only the microservice. In such case some
2424
features of Concorda system cannot be used but basic configuration will be done by using the configuration .env files
25-
Please take a look on this [page](./install-microservice.md) for details.
25+
Please take a look on this [page](./deploy-microservice.md) for details.
2626

27-
![Diagram](https://github.com/Concorda/docs/blob/master/img/microservice.jpeg)
27+
![Diagram](https://github.com/Concorda/docs/blob/master/img/deploy-microservice.jpeg)
28+
29+
## Using Concorda as a Seneca plugin
30+
31+
In this deployment, the client application will use directly Concorda as an internal Seneca type plugin. The client application will be responsable for
32+
loading and passing all required configuration to Concorda plugin.
33+
Please take a look on this [page](./deploy-plugin.md) for details.
34+
35+
![Diagram](https://github.com/Concorda/docs/blob/master/img/deploy-plugin.jpeg)
2836

File renamed without changes.
File renamed without changes.

img/deploy-plugin.jpeg

16.7 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)