diff --git a/README_SETUP.md b/README_SETUP.md index 36cd1574d5af333e71b4b235efbc58ef1aea8ef6..a7cf28528890ff00874bbb8e94160a85346fe3b6 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -1,11 +1,14 @@ -# Requirements +# Getting Started with the CaosDB Server +Here, you find information on requirements, the installation, configuration and more. -## CaosDB Packages +## Requirements + +### CaosDB Packages * caosdb-webui=0.2.1 * caosdb-mysqlbackend=3.0 -## Third-party Software +### Third-party Software * `>=Java 8` * `>=Apache Maven 3.0.4` * `>=Python 3.4` @@ -19,7 +22,7 @@ * `openpyxl` (for XLS/ODS export) * `openssl` (if a custom TLS certificate is required) -### Install the requirements on Debian +#### Install the requirements on Debian On Debian, the required packages can be installed with: apt-get install git make mariadb-server maven openjdk-11-jdk-headless \ @@ -28,21 +31,21 @@ On Debian, the required packages can be installed with: Note that installing MariaDB will uninstall existing MySQL packages and vice versa. -## System +### System * `>=Linux 4.0.0`, `x86_64`, e.g. Ubuntu 18.04 * Mounted filesytem(s) with enough space * Working internet connection (for up-to-date python and java libraries) -## Extensions ## +### Extensions ## -### Web UI ### +#### Web UI ### - If the WebUI shall run, check out the respective submodule: `git submodule update --init caosdb-webui` - Then configure and compile it according to its [documentation](caosdb-webui/README_SETUP.md). -### PAM ### +#### PAM ### Authentication via PAM is possible, for this the PAM development library must be installed and the pam user tool must be compiled: @@ -52,14 +55,14 @@ installed and the pam user tool must be compiled: should print `[FAILED]` and return with a non-zero exit code. Unless there is a user `asdf` with password `ghjk` on your system, of course. -#### Troubleshooting #### +##### Troubleshooting #### If `make` fails with `pam_authentication.c:4:31: fatal error: security/pam_appl.h: No such file or directory` the header files are probably not installed. You can do so under Debian and Ubuntu with `apt-get install libpam0g-dev`. Then try again. -# First Setup +## First Setup After a fresh clone of the repository, this is what you need to setup the server: @@ -133,7 +136,7 @@ server: Done! -# Start Server +## Start Server `$ make run` @@ -144,12 +147,12 @@ type `https://localhost:10443` in your Browser, assuming you used 10443 as port. Note, that you will get a security warning if you are using a self-signed certificate. -# Run Unit Tests +## Run Unit Tests `$ make test` -# Setup Eclipse +## Setup Eclipse 1. Open Eclipse (recommended version: Oxygen.1a Release (4.7.1a)) 2. `File > New > Java Project`: Choose a project name and specify the location @@ -168,9 +171,9 @@ certificate. Done! -# Migration +## Migration -## From 0.1 to 0.2 +### From 0.1 to 0.2 A major change in the code is the renaming of the java packages (from `caosdb.[...]` to `org.caosdb.[...]`). @@ -186,11 +189,11 @@ before you execute it. sed -i.bak -e "s/\(\s*\)\([^.]\)caosdb\.server/\1\2org.caosdb.server/g" FILE_TO_BE_CHANGED ``` -# Build the documentation # +## Build the documentation # Stand-alone documentation is built using Sphinx: `make doc` -## Requirements ## +### Requirements ## - sphinx - javasphinx :: `pip3 install --user javasphinx` diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md deleted file mode 100644 index 6805181e73a7f338fbacb74bdd9f734360404372..0000000000000000000000000000000000000000 --- a/src/doc/getting_started.md +++ /dev/null @@ -1,5 +0,0 @@ -# Getting started with pycaosdb # - -1. Install -2. import -3. enjoy diff --git a/src/doc/index.rst b/src/doc/index.rst index 6edb6b40dfd613b444c5f1219a0fe4e69c7a9ee6..4fb19aca7e45a39bbefcd759bb1e7715cb0f2d77 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -8,7 +8,7 @@ Welcome to caosdb-server's documentation! :hidden: :glob: - Getting started <getting_started> + Getting started <README_SETUP> Concepts <concepts> tutorials administration/*