From 00a3d17da205ff9c310025db8563a5c5872697f9 Mon Sep 17 00:00:00 2001 From: Banana Date: Sat, 4 Oct 2025 23:33:47 +0200 Subject: [PATCH] some documentation cleanups Signed-off-by: Banana --- documentation/{import.md => api-import.md} | 6 +++--- documentation/api.md | 2 +- documentation/backup.md | 2 +- documentation/setup/install.md | 8 ++++++++ documentation/setup/manual-install.md | 9 ++++++++- documentation/usermanagement-and-rights.md | 1 + 6 files changed, 22 insertions(+), 6 deletions(-) rename documentation/{import.md => api-import.md} (94%) diff --git a/documentation/import.md b/documentation/api-import.md similarity index 94% rename from documentation/import.md rename to documentation/api-import.md index 5a7e127..58e0202 100644 --- a/documentation/import.md +++ b/documentation/api-import.md @@ -1,4 +1,4 @@ -# Import +# API Import The API provides an import method. @@ -8,8 +8,8 @@ You need the information which collection to import to and what data can be impo A working php example with example data-crow data can be found here: ``` -http://91.132.146.200:3000/Banana/bibliotheca-tools/src/master/data-crow/run-import-to-bibliotheca.php -http://91.132.146.200:3000/Banana/bibliotheca-tools/src/master/data-crow/README +http://91.132.146.200/gitweb/?p=bibliotheca-tools.git;a=blob_plain;f=data-crow/run-import-to-bibliotheca.php;hb=HEAD +http://91.132.146.200/gitweb/?p=bibliotheca-tools.git;a=blob_plain;f=data-crow/README;hb=HEAD ``` Info which data can be imported in example collation #1 diff --git a/documentation/api.md b/documentation/api.md index e91ec55..88098c4 100644 --- a/documentation/api.md +++ b/documentation/api.md @@ -11,7 +11,7 @@ ID of a collection `collection=NUMBER` Get the latest 10 for given collection `p=list` POST call to add a new entry to given collection. `p=add&collection=NUMBER&authKey=API_AUTH_TOKEN` -See p=addInfo for the details which info is needed in the add call. More information can be found in import.txt +See `p=addInfo` for the details which info is needed in the add call. More information can be found in import.md Describes how the data in the POST add call should be formatted. `p=addInfo&collection=NUMBER` The JSON info in the data field, tells which fields are available and in which format the value diff --git a/documentation/backup.md b/documentation/backup.md index 9660452..ff1ce49 100644 --- a/documentation/backup.md +++ b/documentation/backup.md @@ -4,4 +4,4 @@ Manually create a complete DB export and all the files in the webfolder. # Regular backup -Create a full database export and all the files in the `storage` folder of you installation. +Create a full database export and all the files in the `storage` folder of your installation. diff --git a/documentation/setup/install.md b/documentation/setup/install.md index 5d6cec6..9722632 100644 --- a/documentation/setup/install.md +++ b/documentation/setup/install.md @@ -1,32 +1,40 @@ # Unpack + Unpack the archive in a temp folder. Follow the following steps. After that you can delete the unpacked files # DB Setup + Create a DB and choose a prefix (A _ is added automatically as separation) for your tables. Write down those values. You need them later. # Move files + Move the content of webclient folder to your webspace. # File rights + Make sure that `systemout` folder is read/write accessible for your webserver user. Recursive. Make sure that `storage` folder is read/write accessible for your webserver user. Recursive. Make sure that `config` folder is read/write accessible for your webserver user. Make sure that `setup` folder is read/write accessible for your webserver user. Recursive. # Setup + Open your browser and visit your newly created bibliotheca installation setup with `/setup` Follow the instructions and remember your settings from step DB setup. After completion the setup will delete itself. Remove the `/setup` from the url and you are done. # Access + Open your browser and visit your newly created bibliotheca installation. Default user `admin` and password: `test` # First steps + Login with default admin account and change the password! Create your own user. Create your first collection. See more in first-steps.md # To re-run the setup + Upload the setup folder again. It deletes itself after a successful setup. diff --git a/documentation/setup/manual-install.md b/documentation/setup/manual-install.md index cef803a..17d1c64 100644 --- a/documentation/setup/manual-install.md +++ b/documentation/setup/manual-install.md @@ -1,29 +1,36 @@ # Unpack -Unpack the archive in a temp folder. Follow the steps. After you can delete the unpacked files + +Unpack the archive in a temp folder. Follow the steps. After you can delete the unpacked files. # DB Setup + Create a DB and choose a prefix (A _ is added automatically as separation) for your tables. Open the provided sql file. Search for `#REPLACEME#` and replace it with your table prefix. Save. Import this file into you newly created DB. It is a mysql dump import file. Works with phpmyadmin too. # Config + Copy `webclient/config/config.php.default` to `webclient/config/config.php`. Edit and fill in the DB details. Change `PATH_ABSOLUTE` to you installation path and `PATH_WEB_STORAGE` relative to your webroot. # Move files + Move the content of webclient folder to your webspace. Make sure the location matches the `PATH_ABSOLUTE` config in `config.php` file # File rights + Make sure that `systemout` folder is read/write accessible with your webserver user. Recursive. Make sure that `storage` folder is read/write accessible with your webserver user. Recursive. # Access + Open your browser and visit your newly created bibliotheca installation. Default user `admin` and password: `test` # First steps + Login with default admin account and change the password! Create your own user. Create your first collection. See more in first-steps.md diff --git a/documentation/usermanagement-and-rights.md b/documentation/usermanagement-and-rights.md index fcb016d..273a409 100644 --- a/documentation/usermanagement-and-rights.md +++ b/documentation/usermanagement-and-rights.md @@ -15,6 +15,7 @@ Default user groups are and Should not be changed or removed: ## Rights + A user can be in multiple groups. A collection has one owner and one group. An entry has one owner and group. -- 2.39.5