diff --git a/README.md b/README.md index d673fd9..1d32adf 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ These instructions will get you a copy of the project up and running on your loc To install Hubl, you'll need: -* A Hubl Server (djangoldp>=0.7.11) with the appropriate modules -* A Prosody Server (with [appropriate modules](https://git.startinblox.com/infra/prosody-modules/) +* A [Hubl Server](https://git.startinblox.com/djangoldp-packages/server-manager/) (djangoldp>1) +* A [Prosody Server](https://prosody.im/) (with [appropriate modules](https://git.startinblox.com/infra/prosody-modules/)) * A SMTP Server (optional) * NodeJS on your machine @@ -23,11 +23,11 @@ Before diving in you have to check your Hubl Server supports the following LDP p * djangoldp_profile * djangoldp_skill * djangoldp_uploader -* oidc_provider: 'git+https://github.com/jblemee/django-oidc-provider.git@develop' +* oidc_provider: django-webidoidc-provider Those packages are given with the last stable version tested. -Refer to the [documentation to install a Hubl Server](https://git.startinblox.com/documentation/doc/wikis/devops/install_sib_server) with this configuration. +Refer to the [documentation to install a Hubl Server](https://docs.startinblox.com/import_documentation/install-sib-server.html) with this configuration. ## Build the application @@ -77,6 +77,8 @@ On `config.json`: ```json { "xmpp": "https://jabber.happy-dev.fr/http-bind/", + "clientName": "My local Hubl", + "clientLogo": "/images/logo.webp", "authority": "http://localhost:8000/", "endpoints": { "skills": "http://server.url/skills/", @@ -88,9 +90,13 @@ On `config.json`: Where: +* `clientName` is the name of your Hubl +* `clientLogo` is an URL to an image file * `xmpp` is your [Prosody](https://prosody.im/) 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. +* `endpoints.users` is the API endpoints for Users on your djangoldp server. (djangoldp-account) +* `endpoints.skills` is the API endpoints for Skills on your djangoldp server. (djangoldp-skill) +* `endpoints.uploads` is the API endpoints for Uploads on your djangoldp server. (djangoldp-upload) ### Communities