hubl/README.md

259 lines
6.6 KiB
Markdown
Raw Normal View History

2020-05-08 13:27:44 +00:00
# Hubl
2018-11-07 18:05:32 +00:00
2020-05-08 13:27:44 +00:00
Hubl is the magic tool that allows the Freelance Network to thrive in a decentralized way.
2018-09-28 19:24:25 +00:00
2019-04-29 12:46:13 +00:00
## Getting Started
2018-11-14 12:50:38 +00:00
2019-12-02 14:22:25 +00:00
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
2018-11-14 12:50:38 +00:00
2019-04-29 12:46:13 +00:00
### Prerequisites
2018-11-14 12:50:38 +00:00
2020-05-08 13:27:44 +00:00
To install Hubl, you'll need:
2018-11-14 12:50:38 +00:00
2020-05-08 13:27:44 +00:00
* A Hubl Server (djangoldp>=0.6.42) with the appropriate modules
* A Prosody Server (with [appropriate modules](https://git.startinblox.com/infra/prosody-modules/)
2019-12-02 14:22:25 +00:00
* A SMTP Server (optional)
* NodeJS on your machine
2018-11-14 12:50:38 +00:00
2020-05-08 13:27:44 +00:00
Before diving in you have to check your Hubl Server supports the following LDP packages:
2018-11-14 12:50:38 +00:00
2020-03-14 16:17:27 +00:00
* djangoldp_account
* djangoldp_notification
* djangoldp_profile
* djangoldp_skill
2020-05-08 13:27:44 +00:00
* djangoldp_uploader
2019-12-02 14:22:25 +00:00
* oidc_provider: 'git+https://github.com/jblemee/django-oidc-provider.git@develop'
2018-11-14 12:50:38 +00:00
Those packages are given with the last stable version tested.
2018-11-14 12:50:38 +00:00
2020-05-08 13:27:44 +00:00
Refer to the [documentation to install a Hubl Server](https://git.startinblox.com/documentation/doc/wikis/devops/install_sib_server) with this configuration.
2019-04-29 12:46:13 +00:00
## Build the application
In order to find your server(s) the client application needs to be assembled with the proper configuration.
2019-04-29 12:46:13 +00:00
2020-05-08 13:27:44 +00:00
Get the code of the Hubl on your machine:
2019-12-02 14:22:25 +00:00
```bash
git clone ...
2020-05-08 13:27:44 +00:00
cd hubl
2020-05-04 12:09:39 +00:00
npm install
2019-04-29 12:46:13 +00:00
```
Then create a `config.json` based on your needs, see Mandatory and Optional Modules on this page. For convienence a `config.sample.json` exists in the source.
2020-05-08 13:27:44 +00:00
Federated Hubl needs to use `config.sample.federated.json` example.
2019-04-29 12:46:13 +00:00
You can quickly update your API URI from the samples:
```
2020-05-08 13:27:44 +00:00
$ sed 's/http:\/\/localhost:8000/https:\/\/api.your-server.startinblox.com/' config.sample.json > config.json
```
2020-05-08 13:27:44 +00:00
Then build your new Hubl:
2019-12-02 14:22:25 +00:00
```bash
npm run build
```
2019-04-29 12:46:13 +00:00
The application bundle is in the `dist` folder, ready to be deployed everywhere as a static file.
2019-04-29 12:46:13 +00:00
2019-12-02 14:22:25 +00:00
## Developpers
Serve, watch files & rebuild on change with this command:
```bash
npm run watch
```
## Mandatory modules
2020-05-08 13:27:44 +00:00
By default, a Hubl includes only individual chat modules.
2020-05-08 13:27:44 +00:00
On Server: `djangoldp_account`, `djangoldp_profile`, `djangoldp_notification`, `djangoldp_skill`, `djangoldp_upload`, `oidc_provider` packages
On `config.json`:
```json
{
"xmpp": "https://jabber.happy-dev.fr/http-bind/",
"authority": "http://localhost:8000/",
"endpoints": {
2020-05-27 06:44:54 +00:00
"skills": "http://server.url/skills/",
"users": "http://server.url/users/",
"uploads": "http://server.url/upload/"
}
}
```
Where:
2020-05-08 13:27:44 +00:00
* `xmpp` is your Prosody with [appropriate modules](https://git.startinblox.com/infra/prosody-modules/) configured on.
* `authority` is the OpenID Provider. Usually, if you use `djangoldp-account` it's the same as your djangoldp server.
* `endpoints.users` is the API endpoints for Users on your djangoldp server.
### Optional personalisation
On `config.json`:
```json
2020-05-08 13:27:44 +00:00
"clientName": "Hubl",
"clientFavicon": "/images/favicon.png",
"clientLogo": "/images/logo.png",
"clientLogoHeight": "32px",
"clientCSS": "/path/to/custom.css",
"authorityName": "djangoldp-server-name"
```
Where:
2020-05-08 13:27:44 +00:00
* `clientName` is the name of your Hubl.
* `clientFavicon` is an URL to a distant favicon
* `clientLogo` is an URL to a distant logo for your client
* `clientLogoHeight` allow a quick fix to manage different height logos
2020-05-08 13:27:44 +00:00
* `clientCSS` is an URL to a distant CSS that'll be the last one loaded by the Hubl
* `authorityName` is a visual name of your OpenID Provider
## Optional modules
2020-05-08 13:27:44 +00:00
### Analytics
Hubl support Google or Matomo as analytics trackers. To use them, add to your `config.json`:
```json
"analytics": [
{
"type": "matomo", //Or "google"
"url": "https://my-personal.matomo.cloud/",
"id": "1"
}
]
```
### Circles
Circles are a public group chat. To activate them, you need:
On Server: `djangoldp_circle` packages
2020-05-08 13:27:44 +00:00
On `config.json`:
```json
"endpoints": {
"circle": "http://server.url/circles/"
}
```
2020-05-08 13:27:44 +00:00
### Dashboard
Dashboard includes card generation from HTML. To activate them, you need:
On Server: `djangoldp_dashboard` packages
On `config.json`:
```json
"endpoints": {
"dashboard": "http://server.url/dashboard/"
}
```
2020-05-27 06:44:54 +00:00
A [sample fixture](https://git.startinblox.com/djangoldp-packages/djangoldp-dashboard/blob/master/djangoldp_dashboard/fixtures/sample.json) can be loaded with `./manage.py loaddata path/to/djangoldp_dashboard/fixtures/sample.json`.
### Events
Events allow to create and manage instance-level evenement. To activate them, you need:
2020-05-08 13:27:44 +00:00
On Server: `djangoldp_event`, `djangoldp_upload` packages
2020-05-08 13:27:44 +00:00
On `config.json`:
```json
2020-05-04 12:09:39 +00:00
"endpoints": {
"events": "http://server.url/events/",
"typeevents": "http://server.url/typeevents/",
2020-05-08 13:27:44 +00:00
"uploads": "http://server.url/upload/"
2020-05-04 12:09:39 +00:00
}
```
### Project
(Experimental) Project are a private group chat including Customer and Business Provider management. To activate them, you need:
On Server: `djangoldp_project` packages
2020-05-08 13:27:44 +00:00
On `config.json`:
```json
"endpoints": {
"projects": "http://server.url/projects/",
"customers": "http://server.url/customers/",
"businessproviders": "http://server.url/businessproviders/",
"skills": "http://server.url/skills/"
}
```
### Users Directory
(In development) Directory includes a listing of each users of your app and editable individual profile. To activate them, you need:
2020-05-08 13:27:44 +00:00
On Server: `djangoldp_skill`, `djangoldp_upload` packages
On `config.json`:
```json
2020-05-04 12:09:39 +00:00
"publicDirectory": true,
"endpoints": {
2020-05-04 12:09:39 +00:00
"groups": "http://server.url/groups/",
"skills": "http://server.url/skills/",
"uploads": "http://server.url/upload/"
}
```
2020-05-08 13:27:44 +00:00
### Job Offers
2020-05-08 13:27:44 +00:00
(In development) Job Offers includes a job board with conversation. To activate them, you need:
2020-05-08 13:27:44 +00:00
On Server: `djangoldp_joboffer`, `djangoldp_skill`, `djangoldp_upload`, `djangoldp_conversation` packages
On `config.json`:
```json
"endpoints": {
2020-05-08 13:27:44 +00:00
"joboffers": "http://server.url/joboffers/",
"skills": "http://server.url/skills/",
"uploads": "http://server.url/upload/"
}
```
2020-05-19 13:13:30 +00:00
## Use with docker
### Multi services
Run with a local binding on localhost:
```bash
docker-compose build
docker-compose up -d client server
```
Use in CI context:
```bash
docker-compose -f docker-compose.yml build
docker-compose -f docker-compose.yml up -d client server
docker-compose -f docker-compose.yml run --rm e2e
```
Build and push the server to registry:
```bash
docker build -f docker/djangoldp.docker --build-arg serve="http://localhost:8000" -t registry.startinblox.com/applications/hubl/server:0.1 .
docker push registry.startinblox.com/applications/hubl/server:0.1
```
Note: within a Kubernetes pod all services are bound to `localhost`.
## Built With
2020-05-08 13:27:44 +00:00
* [Sib-Core](https://git.startinblox.com/framework/sib-core/) - An awesome new framework!