Skip to content
Snippets Groups Projects
Commit aa2f93ae authored by Daniel's avatar Daniel
Browse files

DOC: A bit more installation documentation.

parent 12810764
No related branches found
No related tags found
No related merge requests found
......@@ -9,12 +9,16 @@
* >=Make 3.81
* >=Screen 4.01
* >=MySQL 5.5 (better >=5.6) or >=MariaDB 10.1
* unzip
### Install the requirements on Debian
On Debian, the required packages can be installed with:
apt-get install git make mariadb-server maven openjdk-8-jdk-headless \
python3-pip screen
python3-pip screen unzip
Note that installing MariaDB will uninstall existing MySQL packages and vice
versa.
## System
......@@ -22,12 +26,21 @@ On Debian, the required packages can be installed with:
* Mounted filesytem(s) with enough space
* Working internet connection (for up-to-date python and java libraries)
## Extensions ##
### 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).
# First Setup
After a fresh clone of the repository, this is what you need to setup the
server:
1. It is recommended to run the unit tests with `make test`
1. Compile the server with `make compile`
1. It is recommended to run the unit tests with `make test`.
2. Create an SSL certificate somewhere with a `Java Key Store` file. For
self-signed certificates (not recommended for production use) you can do:
- `mkdir certificates; cd certificates`
......@@ -49,9 +62,9 @@ server:
Make sure that the conf file is not readable by other users because the
certificate passwords are stored in plaintext.
* Set the file system paths:
- `FILE_SYSTEM_ROOT`: The root for all the files managed by CaosDB.
- `DROP_OFF_BOX`: Where to put files for insertion into CaosDB
- `TMP_FILES`: <To do, what's this good for?>
- `FILE_SYSTEM_ROOT`: The root for all the files managed by CaosDB.
- `DROP_OFF_BOX`: Where to put files for insertion into CaosDB
- `TMP_FILES`: <To do, what's this good for?>
* Maybe set another `SESSION_TIMEOUT_MS`.
4. Copy `conf/usersources.ini.template` to `conf/usersources.ini`.
* Define the users/groups who you want to include/exclude.
......
# Requirements
- pam development files: In Debian install with `apt-get install libpam0g-dev`.
# Install
`$ make`
## Troubleshooting
* In the case that the install 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.
* 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.
# Run Tests
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment