Commit 6907d27e authored by mrodzis's avatar mrodzis 🦊

Merge branch 'feature/#115-installation-docs' into 'develop'

Update information about SADE installation

See merge request !87
parents c36670ab cab1e54f
...@@ -4,27 +4,51 @@ ...@@ -4,27 +4,51 @@
SADE is provided as Debian package for Debian based Linux distributions like Ubuntu. SADE is provided as Debian package for Debian based Linux distributions like Ubuntu.
### Installation from command line
Latest snapshot development packages can be downloaded from Latest snapshot development packages can be downloaded from
[https://ci.de.dariah.eu/packages/pool/snapshots/s/sade/](https://ci.de.dariah.eu/packages/pool/snapshots/s/sade/) [https://ci.de.dariah.eu/packages/pool/snapshots/s/sade/](https://ci.de.dariah.eu/packages/pool/snapshots/s/sade/)
After downloading the latest Debian package, install it from command line
```sh
sudo dpkg -i sade_*.deb
```
while selecting the appropriate version and date of the package. After the package's
installation, eXist-db fires up and is available at [http://localhost:8080/](http://localhost:8080/).
### Installation with Debian's Software Center
Another option to install SADE is using Debian's Software Center. First, download a SADE
Debian package as described above and double click on it from your desktop environments
file manager. The Software Center should launch and guide you through the installation.
As soon as the installation is complete, eXist-db takes a moment to fire up and is
then available at [http://localhost:8080/](http://localhost:8080/).
## All Operating Systems ## All Operating Systems
Make sure to have [Java](https://www.java.com/de/download/) at least in version 1.8 installed. Make sure you have [Java](https://www.java.com/de/download/) installed at least in version
1.8.
Download SADE as zip file: Download SADE as a zip file:
* [latest release](https://gitlab.gwdg.de/SADE/build/-/jobs/artifacts/master/download?job=build-master) - recommended * [latest release](https://gitlab.gwdg.de/SADE/build/-/jobs/artifacts/master/download?job=build-master) - recommended
* [lastest unstable and untested build](https://gitlab.gwdg.de/SADE/build/-/jobs/artifacts/develop/download?job=build-develop) * [lastest unstable and untested build](https://gitlab.gwdg.de/SADE/build/-/jobs/artifacts/develop/download?job=build-develop)
https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/download?job=<job_name> Unzip the `artifacts.zip` file and change to the `build/sade/bin` directory.
https://gitlab.gwdg.de/SADE/build/-/jobs/artifacts/master/download?job=build-master Start the service with `./startup.sh` (Linux/Mac) or `startup.bat` (Windows).
If you are experiencing problems starting SADE this way you may also try to change to the
`build/sade` directory and enter `java -jar start.jar jetty` from the command line.
Unzip the file `artifacts.zip`and change to directory `build/sade/bin` Finally, eXist-db's front and back end are available at [http://localhost:8080/](http://localhost:8080/)
and the local SADE is visible at
[http://localhost:8080/exist/apps/sade/index.html](http://localhost:8080/exist/apps/sade/index.html).
Start the service with `./startup.sh` (Linux/Mac) or `startup.bat` (Windows). ## How to log in
If you have problems starting SADE this way you may also try to change to directory `build/sade` and enter `java -jar start.jar jetty` SADE is initialized with a default superuser `admin` with an empty password.
Finally eXist front and back end is available at [http://localhost:8080/](http://localhost:8080/) and the local SADE is visible at __Caution:__ Provide the superuser `admin` with a password, if you plan to deploy your
[http://localhost:8080/exist/apps/sade/index.html](http://localhost:8080/exist/apps/sade/index.html). SADE instance to a server.
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
<prepare>pre-install.xq</prepare> <prepare>pre-install.xq</prepare>
<finish>post-install.xq</finish> <finish>post-install.xq</finish>
<changelog> <changelog>
<change version="4.2.0"> <change version="5.0.0">
<ul xmlns="http://www.w3.org/1999/xhtml"> <ul xmlns="http://www.w3.org/1999/xhtml">
<li class="feat">Features <li class="feat">Features
<ul> <ul>
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
<li>Add document how to use faceted search</li> <li>Add document how to use faceted search</li>
<li>Pretty print test results on command line</li> <li>Pretty print test results on command line</li>
<li>Server side pagination for search.html</li> <li>Server side pagination for search.html</li>
<li>Enhance documentation about how to install SADE</li>
</ul> </ul>
</li> </li>
<li class="bugs">Bugfixes <li class="bugs">Bugfixes
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment