aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas "Cakeisalie5" Touhey <thomas@touhey.fr>2019-03-26 12:43:32 +0100
committerThomas "Cakeisalie5" Touhey <thomas@touhey.fr>2019-03-26 12:43:32 +0100
commita36a315b88b8fc1d2afa0fadb94af5024689a51c (patch)
treecb857e8c5dced8f4d9436c06eafcaf5ca8ff0475
parent677481125e454f89efa3d6386d6b6f5856293f65 (diff)
Added some info about valorise-toi.sgdf.fr
-rw-r--r--docs/environment.rst4
-rw-r--r--docs/valorise-toi/index.rst129
2 files changed, 130 insertions, 3 deletions
diff --git a/docs/environment.rst b/docs/environment.rst
index a5f4e14..2aa2a9e 100644
--- a/docs/environment.rst
+++ b/docs/environment.rst
@@ -52,7 +52,7 @@ Amongst the showcase and news websites of the organization are:
- `<https://valorise-toi.sgdf.fr/>`_: the “Valorise-toi” tool, which allows
you to highlight the skills you have acquired, are acquiring or wish to
acquire through your experience as a scout leader, for when you're looking
- for a job for example.
+ for a job for example. See :ref:`valorise-toi` for more.
- `<https://formation.sgdf.fr/>`_: a training course lookup tool, easier to
use than the one on the intranet (although you still need the intranet
to register).
@@ -74,8 +74,6 @@ The `main website <https://www.sgdf.fr/>`_, also contains a few tools:
The Intranet
------------
-
-
.. toctree::
:maxdepth: 2
diff --git a/docs/valorise-toi/index.rst b/docs/valorise-toi/index.rst
new file mode 100644
index 0000000..32c691a
--- /dev/null
+++ b/docs/valorise-toi/index.rst
@@ -0,0 +1,129 @@
+.. _valorise-toi:
+
+Valorise-toi
+============
+
+A website is made available to those who want to valorize their skills
+acquired through scoutism in their work environment. It is available through:
+
+- `<https://valorise-toi.sgdf.fr/>`_ for the production site.
+- `<https://dev-valorise-toi.sgdf.fr/>`_ for the development site (not
+ accessible but used in the Instagram callback, possibly obsolete).
+
+The following routes are available:
+
+``/``
+ The main index, where you can login through different methods:
+
+ - intranet identifiers (enabled, see ``/intranet.php``).
+ - twitter (enabled, see ``/twitter/index.php``).
+ - facebook (disabled and no route could be found?).
+ - instagram (disabled, see ``/instagram.php``).
+
+ The Facebook login page doesn't exist here, but commented is the
+ application ID, ``1079671825469858``.
+
+``/intranet.php``
+ The intranet login page. Contains a form leading to
+ ``/requete_intranet.php``.
+
+ Calls ``/requete_intranet.php`` then ``/set_cookies.php`` if it worked.
+
+``/requete_intranet.php``
+ Supposed to be loaded in POST with the following arguments:
+
+ ``numad``
+ The adherent number (e.g. ``160000000``).
+
+ ``mdpad``
+ The adherent password.
+
+``/set_cookies.php``
+ Supposed to be loaded in POST with the following arguments:
+
+ ``namefb``
+ ``LASTNAME+FIRSTNAME``
+
+ ``idfb``
+ ``LASTNAME+FIRSTNAME``
+
+ Answers ``success`` (?).
+
+``/twitter/index.php``
+ Redirects to the Twitter login page,
+ ``https://api.twitter.com/oauth/authorize``, with the following
+ GET arguments:
+
+ ``oauth_token``
+ The application token, ``Zk_mKAAAAAAA3fiEAAABabmTL_c``.
+
+ See ``/twitter/callback.php`` for when the login process is successful.
+
+``/twitter/callback.php``
+ The Twitter OAuth process callback. Takes the following GET arguments:
+
+ ``oauth_token``
+ The application token, ``Zk_mKAAAAAAA3fiEAAABabmTL_c``.
+
+ ``oauth_verifier``
+ A token obtained by logging the user in.
+
+ Redirects to ``../accueil.php`` if the login was successful,
+ and to ``../index.php`` otherwise.
+
+``/instagram.php``
+ A private page (not indexed) redirecting to the Instagram login page for
+ applications, ``https://api.instagram.com/oauth/authorize``, with the
+ following GET arguments:
+
+ ``client_id``
+ The client ID (?), here ``7d209918d46f4c82836a16bf96531ba1``.
+
+ ``redirect_uri``
+ Where to redirect afterwards, redirects to
+ ``/instagram_callback.php&scope=basic&response_type=code`` on the
+ development website (see ``/instagram_callback.php``).
+
+ The login process actually doesn't work as we get an
+ ``OAuthForbiddenException`` (403) with the following explanation:
+
+ > You are not a sandbox user of this client
+
+``/instagram_callback.php``
+ An instagram callback using the following GET arguments:
+
+ ``scope``
+ The scope (probably?), here ``basic``.
+
+ ``response_type``
+ Here ``code`` (?).
+
+``/accueil.php``, ``/modedemploi.php``, ``/page.php``, ``/radar.php``,
+``/etape3.php``, ``/etape4.php``
+ The static pages with scripts, respectively:
+
+ - the main page.
+ - a help page.
+ - the first step (evaluate your skills), with a GET argument, ``idt``,
+ being the page number (e.g. ``2``) for evaluating skills.
+ - the second step.
+ - the third step.
+ - the fourth step.
+
+``/set_answer.php``
+ Loaded in POST with the following arguments:
+
+ ``idf``
+ ``LASTNAME+FIRSTNAME``
+
+ ``idq``
+ The question ID.
+
+ ``rep``
+ The answer ID.
+
+``/pdf.php``
+ The PDF generation page, with the answers saved on the server-side.
+
+``/deco.php``
+ The logout page, redirects to ``/index.php``.