Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions docs/convert-docs.sh

This file was deleted.

34 changes: 32 additions & 2 deletions docs/source/API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Accessories
POST Services
~~~~~~~~~~~~~

na.
Not applicable.

GET Services
~~~~~~~~~~~~
Expand Down Expand Up @@ -137,6 +137,11 @@ CreateAccount

**Route:** ``/Web/Services/index.php/Accounts/``

.. note::

It is required for the route to end with the ``/`` character, or it will
fail.

**Response:**

Unstructured response of type *AccountCreatedResponse*
Expand Down Expand Up @@ -298,6 +303,11 @@ CreateCustomAttribute

*This service is only available to application administrators*

.. note::

It is required for the route to end with the ``/`` character, or it will
fail.

**Response:**

.. code:: json
Expand Down Expand Up @@ -619,6 +629,11 @@ Creates a new group

*This service is only available to application administrators*

.. note::

It is required for the route to end with the ``/`` character, or it will
fail.

**Response:**

.. code:: json
Expand Down Expand Up @@ -922,6 +937,11 @@ Creates a new reservation

*This service is secure and requires authentication*

.. note::

It is required for the route to end with the ``/`` character, or it will
fail.

**Response:**

.. code:: json
Expand Down Expand Up @@ -1466,6 +1486,11 @@ Creates a new resource

*This service is only available to application administrators*

.. note::

It is required for the route to end with the ``/`` character, or it will
fail.

**Response:**

.. code:: json
Expand Down Expand Up @@ -2047,7 +2072,7 @@ Schedules
POST Services
~~~~~~~~~~~~~

na.
Not applicable.

.. _get-services-7:

Expand Down Expand Up @@ -2307,6 +2332,11 @@ Creates a new user

*This service is only available to application administrators*

.. note::

It is required for the route to end with the ``/`` character, or it will
fail.

**Response:**

.. code:: json
Expand Down
15 changes: 9 additions & 6 deletions docs/source/INSTALLATION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ client applications.
Prerequisites
^^^^^^^^^^^^^

- PHP 7.0 or greater
- PHP 8.2 or greater
- To use ‘friendly’ URLs, mod_rewrite or URL rewriting must be enabled
- Your web server must accept all verbs: GET, POST, PUT, DELETE

Expand All @@ -348,11 +348,14 @@ Configuration
API Documentation
^^^^^^^^^^^^^^^^^

| Auto-generated documentation for API usage can be found by browsing
http://your_librebooking_url/Web/Services.
| This documentation describes each available service, indicates whether
or not the service is available to unauthenticated
users/administrators, and provides example requests/responses.
Auto-generated documentation for API usage can be found by browsing
http://your_librebooking_url/Web/Services.

API documentation is also available at :doc:`API`

This documentation describes each available service, indicates whether or not
the service is available to unauthenticated users/administrators, and provides
example requests/responses.

Consuming the API
^^^^^^^^^^^^^^^^^
Expand Down
28 changes: 17 additions & 11 deletions docs/source/SAML-Configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,12 @@ SimpleSAMLphp has a lot of configuration options. If you’re like me and
far from an expert in SAML, it’s overwhelming. Luckily, since
LibreBooking is a Service Provider it doesn’t need anything special.
I’ll go through each of the settings that need to be updated
individually. Please note that at the time of writing this post, the
latest version of SimpleSAMLphp was 1.18.5. It’s possible that the names
of the options will change in future versions.
individually.

.. note::
At the time of writing this post, the latest version of SimpleSAMLphp was
1.18.5. It’s possible that the names of the options will change in future
versions.

Copy ``/home/username/simplesamlphp/config/config.php.dist`` to
``/home/username/simplesamlphp/config/config.php``
Expand Down Expand Up @@ -188,15 +191,18 @@ Some Restrictions

A couple important notes with SAML enabled:

The first is that you will no longer be able to log into LibreBooking
with any other credentials. There is no “back door” – so every
authentication request will be routed through SAML.
.. warning::

You will no longer be able to log into LibreBooking with any other
credentials. There is no “back door” – so every authentication request will
be routed through SAML.

.. warning::

The other restriction is that you will not be able to use any
authenticated method from the API. SAML performs a series of browser
redirects in order to complete the authentication process. When using
the API you are not within the context of a browser, so authentication
will fail.
You will not be able to use any authenticated method from the API. SAML
performs a series of browser redirects in order to complete the
authentication process. When using the API you are not within the context
of a browser, so authentication will fail.

Logging In
----------
Expand Down