diff --git a/README.md b/README.md index 605a26c..2ac6b46 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,4 @@ easy-deposit-agreement-creator Create a deposit agreement (pdf file) for a given dataset. -Browse to the [documentation site](http://dans-knaw.github.io/easy-deposit-agreement-creator/01_manual.html) for more information. +Browse to the [documentation site](http://dans-knaw.github.io/easy-deposit-agreement-creator) for more information. diff --git a/docs/01_manual.md b/docs/01_manual.md deleted file mode 100755 index e69de29..0000000 diff --git a/docs/api/api.yml b/docs/api/api.yml index da76d75..13f6659 100755 --- a/docs/api/api.yml +++ b/docs/api/api.yml @@ -1,14 +1,13 @@ openapi: 3.0.1 servers: - - description: Debug environment - url: http://localhost:/ - - description: Local Vagrant machine - url: http://test.dans.knaw.nl + - description: Local machine + url: http://localhost:20130/ + info: description: Private interface for generating Deposit Agreements for depositing datasets to EASY - version: 1.0.0 - title: Deposit Agreement API + version: 2.0.4 + title: Deposit Agreement Creator API contact: email: info@dans.knaw.nl license: @@ -39,6 +38,8 @@ paths: description: Service is unavailable because of an error. /create: post: + tags: + - agreement summary: Returns a Deposit Agreement based on the EASY datasetId in Fedora parameters: - name: datasetId diff --git a/docs/index.md b/docs/index.md index b96c99b..4208c96 100755 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ Manual ====== +[![Build Status](https://travis-ci.org/DANS-KNAW/easy-deposit-agreement-creator.png?branch=master)](https://travis-ci.org/DANS-KNAW/easy-deposit-agreement-creator) SYNOPSIS -------- @@ -48,18 +49,12 @@ ARGUMENTS INSTALLATION AND CONFIGURATION ------------------------------ +Currently this project is built as an RPM package for RHEL7/CentOS7 and later. The RPM will install the binaries to +`/opt/dans.knaw.nl/easy-deposit-agreement-creator` and the configuration files to `/etc/opt/dans.knaw.nl/easy-deposit-agreement-creator`. -1. Unzip the tarball to a directory of your choice, e.g. /opt/ -2. A new directory called easy-deposit-agreement-creator- will be created -3. Add the command script to your `PATH` environment variable by creating a symbolic link to it from a directory that is - on the path, e.g. - - ln -s /opt/easy-deposit-agreement-creator-/bin/easy-deposit-agreement-creator /usr/bin - - - -General configuration settings can be set in `src/main/assembly/dist/cfg/appliation.properties` and logging can be configured -in `src/main/assembly/dist/cfg/logback.xml`. The available settings are explained in comments in aforementioned files. +To install the module on systems that do not support RPM, you can copy and unarchive the tarball to the target host. +You will have to take care of placing the files in the correct locations for your system yourself. For instructions +on building the tarball, see next section. **WeasyPrint** is installed according to the [installation page]({{ weasyprint_installation }}) or via: @@ -82,9 +77,18 @@ Prerequisites: * Java 8 or higher * Maven 3.3.3 or higher +* RPM Steps: git clone https://github.com/DANS-KNAW/easy-deposit-agreement-creator.git cd easy-deposit-agreement-creator mvn install + +If the `rpm` executable is found at `/usr/local/bin/rpm`, the build profile that includes the RPM +packaging will be activated. If `rpm` is available, but at a different path, then activate it by using +Maven's `-P` switch: `mvn -Pprm install`. + +Alternatively, to build the tarball execute: + + mvn clean install assembly:single