update doc

Signed-off-by: prashant-gurung899 <prasantgrg777@gmail.com>
This commit is contained in:
prashant-gurung899
2025-04-10 14:51:51 +05:45
parent 307589c983
commit f039e7e668
2 changed files with 7 additions and 2 deletions

View File

@@ -10,6 +10,9 @@ geekdocFilePath: testing.md
{{< toc >}}
To run tests in the test suite you have two options. You may go the easy way and just run the test suite in docker. But for some tasks you could also need to install the test suite natively, which requires a little more setup since PHP and some dependencies need to be installed.
{{< hint info >}}
To run the tests PHP version ">= 8.2.0" is required.
{{< /hint >}}
Both ways to run tests with the test suites are described here.

View File

@@ -1,6 +1,6 @@
## oCIS Wrapper
A tool that wraps the oCIS binary and provides a way to re-configure the running oCIS instance.
The oCIS wrapper is a tool that wraps the oCIS binary and allows to dynamically reconfigure or extend the running instance. This is done by sending JSON payloads with updated environment variables.
When run, **ociswrapper** starts an API server that exposes some endpoints to re-configure the oCIS server.
@@ -25,11 +25,13 @@ When run, **ociswrapper** starts an API server that exposes some endpoints to re
```
```bash
--bin string Full oCIS binary path (default "/usr/bin/ocis")
--url string oCIS server url (default "https://localhost:9200")
--retry string Number of retries to start oCIS server (default "5")
-p, --port string Wrapper API server port (default "5200")
--admin-username string admin username for oCIS server
--admin-password string admin password for oCIS server
--skip-ocis-run Skip running oCIS server
```
Access the API server at `http://localhost:5200`.
@@ -38,7 +40,7 @@ Also, see `./bin/ociswrapper help` for more information.
### API
**ociswrapper** exposes two endpoints:
**ociswrapper** exposes the following endpoints:
1. `PUT /config`