Dear Gitlab users, due to maintenance reasons, Gitlab will not be available on Thursday 30.09.2021 from 5:00 pm to approximately 5:30 pm.

Commit a1046c5a authored by Andreas Wagner's avatar Andreas Wagner
Browse files

Change institute name.

parent e3e100cc
......@@ -6,7 +6,7 @@
[![Release](https://img.shields.io/gitlab.gwdg.de/rg-mpg-de/tei2zenodo.svg?style=flat-square)](https://gitlab.gwdg.de/rg-mpg-de/tei2zenodo/releases/latest)
-->
This is the "TEI to Zenodo Webservice" software developed at the [Max Planck Institute for European Legal History](http://www.rg.mpg.de/). It is meant to provide a means to quickly push [TEI-encoded XML files](https://tei-c.org/guidelines/p5/) to [Zenodo](https://about.zenodo.org/) deposits, thereby assigning them a DOI identifier and committing them to long-term archival. The service's REST API accepts direct file uploads or webhook calls, both via POST requests. The idea is that you run the service on your infrastructure and configure a webhook in your git repository calling it. Upon being called, it looks up and retrieves the relevant TEI files from the repository and creates individual zenodo deposits for each of them.
This is the "TEI to Zenodo Webservice" software developed at the [Max Planck Institute for Legal History and Legal Theory](http://www.rg.mpg.de/). It is meant to provide a means to quickly push [TEI-encoded XML files](https://tei-c.org/guidelines/p5/) to [Zenodo](https://about.zenodo.org/) deposits, thereby assigning them a DOI identifier and committing them to long-term archival. The service's REST API accepts direct file uploads or webhook calls, both via POST requests. The idea is that you run the service on your infrastructure and configure a webhook in your git repository calling it. Upon being called, it looks up and retrieves the relevant TEI files from the repository and creates individual zenodo deposits for each of them.
This webservice:
......@@ -37,11 +37,11 @@ Note that, since the XPath library that this service uses only supports basic XP
## Installation \& Setup
There are several ways of obtaining the software. It is not necessary to install it in a particular place, it just needs to find a configuration file (see below) and have sufficient privileges to bind to the port specified in the config. So, if you have it installed and configured, just call `t2zd` (or `sudo t2zd` if necessary) form a command line and that's it.
There are several ways of obtaining the software. It is not necessary to install it in a particular place, it just needs to find a configuration file (see below) and have sufficient privileges to bind to the port specified in the config. So, if you have it installed and configured, just call `t2zd` (or `sudo t2zd` if necessary) from a command line and that's it.
1. The default way of getting the software is downloading an asset on the [releases page](https://gitlab.gwdg.de/rg-mpg-de/tei2zenodo/-/releases). There are precompiled binaries zipped together with a configuration template on that page.
2. The package is maintained as a [Go](https://golang.org/) repository, so if you have Go installed, you can use it to compile and install the software in one single step: with the command `go get -u gitlab.gwdg.de/rg-mpg-de/tei2zenodo`. This will put the executable in the `$GOPATH/bin` directory, so that, on a standard Go installation, it can be found automatically from whatever directory you're in.
2. The package is maintained as a [Go](https://golang.org/) repository, so if you have Go installed, you can use it to compile and install the software in one single step: with the command `go install gitlab.gwdg.de/rg-mpg-de/tei2zenodo/cmd/t2zd@latest`. This will put the executable in the `$GOPATH/bin` directory, so that, on a standard Go installation, it can be found automatically from whatever directory you're in. However, you will also need to manually download and modify the [config.json](./configs/config.json.tpl) and the [templates directory](./templates)
3. If you want to compile the source code manually yourself, you need the [Go compiler](https://golang.org/) as well. Then, after retrieving the source code, either by cloning the git repository or by using one of the "download source code" options, you can compile it in its main directory with the command `go build -ldflags "-s -w" -o t2zd cmd/t2zd/main.go`. You can even skip the optimization switches (`-ldflags ...`) or the naming part (`-o t2zd`) and just say `go build cmd/t2zd/main.go` (then the command to launch the server would be `main`), but the longer command is the one I recommend and am using most of the time.
......
......@@ -233,7 +233,7 @@
<div class="navbar">
<p style="float: left; margin-top: 0.8em">
Credits: <a href="https://www.rg.mpg.de">Max Plack Institute for European Legal History</a> (<a href="https://twitter.com/rg_mpg">@rg_mpg</a>)
Credits: <a href="https://www.rg.mpg.de">Max Plack Institute for Legal History and Legal Theory</a> (<a href="https://twitter.com/rg_mpg">@rg_mpg</a>)
<br/>Research Software Engineering: <a href="https://orcid.org/0000-0003-1835-1653">Andreas Wagner</a>
<br/>Software licensed under <a href="http://opensource.org/licenses/MIT">MIT</a>, content and documentation licensed under <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY 4.0</a>
</p>
......
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