Skip to content
Snippets Groups Projects
Commit e089f461 authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

Merge branch 'archive-section' into 'master'

chore: move proxy and old konnectors to archive

See merge request !75
parents 9693f214 9176e21e
No related branches found
No related tags found
1 merge request!75chore: move proxy and old konnectors to archive
Pipeline #102798 passed
Showing
with 62 additions and 40 deletions
# Pilote # Pilote
:::warning DEPRECATED
This section of documentation is not relevant anymore.
:::
<Center>![pilote](/img/mps.png)</Center> <Center>![pilote](/img/mps.png)</Center>
Pilote aims to help people in various administrative processes, allowing them to share their personal information with a social worker to build the best possible claim for every needs. Pilote aims to help people in various administrative processes, allowing them to share their personal information with a social worker to build the best possible claim for every needs.
:::danger "Reminder" :::danger "Reminder"
If you're a new developer tasked to work on this project, please get acquainted with the team [processes](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) and read the advised [dev environment](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) documentation and the self-data [prerequisites](../getting-started/setup.md#installing-prerequisites). If you're a new developer tasked to work on this project, please get acquainted with the team [processes](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) and read the advised [dev environment](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) documentation and the self-data [prerequisites](/docs/getting-started/setup.md#installing-prerequisites).
::: :::
## ![gitlab](/img/gitlab-logo.svg) Repositories ## ![gitlab](/img/gitlab-logo.svg) Repositories
......
# Description # Proxy Description
:::warning DEPRECATED
This section of documentation is not relevant anymore, The proxy is no longer used since we don't use Oauth anymore.
:::
This section of documentation refers to the Oauth protocols working hand in hand with our custom proxy and the cozy-stack. This section of documentation refers to the Oauth protocols working hand in hand with our custom proxy and the cozy-stack.
To fully understand its whereabouts, you should also look at the [enedis konnector](/docs/konnectors/enedis.md) and [grdf konnector](/docs/konnectors/grdf.md) documentation. To fully understand its whereabouts, you should also look at the [enedis konnector](/docs/archive/enedis.md) and [grdf konnector](/docs/archive/grdf.md) documentation.
![gitlab](/img/gitlab-logo.svg) [proxy](https://forge.grandlyon.com/pocs/cozy/cozy-oauth-proxy) ![gitlab](/img/gitlab-logo.svg) [proxy](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/cozy-oauth-proxy)
## Oauth Dance ## Oauth Dance
...@@ -11,7 +15,10 @@ To access customer data, one must first obtain customer authorization. This auth ...@@ -11,7 +15,10 @@ To access customer data, one must first obtain customer authorization. This auth
These APIs implement Oauth 2.0 protocol, it requires authentication from the customer along with its given consent. These APIs implement Oauth 2.0 protocol, it requires authentication from the customer along with its given consent.
See both **[Enedis](./use_cases/enedis.mdx)** and **[Grdf](./use_cases/grdfadict.md)** use cases before going further. See both use cases before going further :
- **[Enedis](./use_cases/enedis.mdx)**
- **[Grdf](./use_cases/grdfadict.md)**
### Cozy Oauth Protocol ### Cozy Oauth Protocol
...@@ -119,7 +126,7 @@ With that in mind, the proxy is now the one calling the auth and token provider ...@@ -119,7 +126,7 @@ With that in mind, the proxy is now the one calling the auth and token provider
## Proxy Code Explained ## Proxy Code Explained
:::info reminder :::info reminder
Feel free to check the proxy [code](https://forge.grandlyon.com/pocs/cozy/cozy-oauth-proxy) at all time when reading this documentation. Feel free to check the proxy [code](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/cozy-oauth-proxy) at all time when reading this documentation.
::: :::
The proxy is coded in golang. The proxy is coded in golang.
......
...@@ -30,3 +30,30 @@ Some variation have to be considered : ...@@ -30,3 +30,30 @@ Some variation have to be considered :
- [enedis sge](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector) - [enedis sge](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector)
- [grdf](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector) - [grdf](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector)
- [egl](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector) - [egl](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector)
## Working with konnectors locally
### Cozy resources
Please see also the [official cozy documentation](https://docs.cozy.io/en/cozy-konnector-libs/).
### Run a konnector locally
To develop a konnector or test it, you will need to be able to run a konnector without the constraints imposed by the cozy stack.
To help you, cozy developed a **standalone** mode for konnectors.
Simply launch it by typing:
`yarn standalone`
This command will create a **konnector-dev-config.json** file if it was not in your project folder before.
This file needs to hold all the information transmitted by the cozy stack when the konnector runs by default
- baseUrl
- apiAuthKey
- login
- password and so on...
Type them all in the *fields* object.
All data recovered by the standalone konnector will be stored in the *data* folder.
# EGL Konnector # EGL
[EGL repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector). [EGL repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector).
......
# Enedis SGE Konnector # Enedis SGE
This konnector fetches consumption measures from Enedis SGE SOAP API. This konnector fetches consumption measures from Enedis SGE SOAP API.
......
# GRDF Tiers Direct # GRDF Tiers Direct
Le connecteur GRDF Tiers Direct prend place dans un contexte où le parcours [Client Connect](./grdf.md) se complexifie et rend l'accès à la donnée trop compliqué pour nos utilisateurs. Le connecteur GRDF Tiers Direct prend place dans un contexte où le parcours [Client Connect](../archive/grdf.md) se complexifie et rend l'accès à la donnée trop compliqué pour nos utilisateurs.
Le parcours **"Tiers Direct"** vise à déléguer cette complexité en laissant la gestion du consentement et de son périmètre au tiers (Métropole de Lyon). Le parcours **"Tiers Direct"** vise à déléguer cette complexité en laissant la gestion du consentement et de son périmètre au tiers (Métropole de Lyon).
......
# Working with konnectors locally
## Cozy resources
Please see also the [official cozy documentation](https://docs.cozy.io/en/cozy-konnector-libs/).
## Run a konnector locally
To develop a konnector or test it, you will need to be able to run a konnector without the constraints imposed by the cozy stack.
To help you, cozy developed a **standalone** mode for konnectors.
Simply launch it by typing:
`yarn standalone`
This command will create a **konnector-dev-config.json** file if it was not in your project folder before.
This file needs to hold all the information transmitted by the cozy stack when the konnector runs by default
- baseUrl
- apiAuthKey
- login
- password and so on...
Type them all in the *fields* object.
All data recovered by the standalone konnector will be stored in the *data* folder.
File moved
...@@ -73,16 +73,16 @@ const config: Config = { ...@@ -73,16 +73,16 @@ const config: Config = {
// position: 'left', // position: 'left',
// label: 'Ecolyo', // label: 'Ecolyo',
// }, // },
{ to: '/docs/getting-started/setup', label: 'Getting started' },
{ to: '/docs/ecolyo/', label: 'Ecolyo' }, { to: '/docs/ecolyo/', label: 'Ecolyo' },
{ to: '/docs/ecolyo-agent/', label: 'Ecolyo Agent' }, { to: '/docs/ecolyo-agent/', label: 'Ecolyo Agent' },
{ to: '/docs/konnectors/introduction', label: 'Konnectors' }, { to: '/docs/konnectors/introduction', label: 'Konnectors' },
{ to: '/docs/getting-started/setup', label: 'Getting started' },
{ {
type: 'dropdown', type: 'dropdown',
label: 'Infra', label: 'Infra',
items: [ items: [
{ to: '/docs/openshift', label: 'Openshift' }, { to: '/docs/openshift', label: 'Openshift' },
{ to: '/docs/proxy/description', label: 'Proxy' }, { to: '/docs/monitoring', label: 'Monitoring' },
], ],
}, },
{ {
...@@ -99,7 +99,18 @@ const config: Config = { ...@@ -99,7 +99,18 @@ const config: Config = {
type: 'dropdown', type: 'dropdown',
label: 'Archive', label: 'Archive',
position: 'right', position: 'right',
items: [{ to: '/docs/pilote', label: 'Pilote' }], items: [
{ to: '/docs/archive/pilote', label: 'Pilote' },
{ to: '/docs/archive/proxy', label: 'Proxy' },
{
label: 'GRDF Client Connect',
to: '/docs/archive/grdf',
},
{
label: 'Enedis Data Connect',
to: '/docs/archive/enedis',
},
],
}, },
{ {
href: 'https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc', href: 'https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc',
......
...@@ -20,8 +20,7 @@ const sidebars: SidebarsConfig = { ...@@ -20,8 +20,7 @@ const sidebars: SidebarsConfig = {
gettingStarted: [{ type: 'autogenerated', dirName: 'getting-started' }], gettingStarted: [{ type: 'autogenerated', dirName: 'getting-started' }],
konnectors: [{ type: 'autogenerated', dirName: 'konnectors' }], konnectors: [{ type: 'autogenerated', dirName: 'konnectors' }],
openshift: [{ type: 'autogenerated', dirName: 'openshift' }], openshift: [{ type: 'autogenerated', dirName: 'openshift' }],
pilote: [{ type: 'autogenerated', dirName: 'pilote' }], archive: [{ type: 'autogenerated', dirName: 'archive' }],
proxy: [{ type: 'autogenerated', dirName: 'cozystack' }],
// this custom sidebar allows isolation inside the page but requires much more configuration // this custom sidebar allows isolation inside the page but requires much more configuration
// ecolyoSidebar: [ // ecolyoSidebar: [
// { type: 'doc', id: 'ecolyo/index', label: 'Introduction' }, // { type: 'doc', id: 'ecolyo/index', label: 'Introduction' },
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment