Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
DBRepo
Manage
Activity
Members
Labels
Plan
External wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FAIR Data Austria DB Repository
DBRepo
Commits
1f8dd40b
Unverified
Commit
1f8dd40b
authored
Nov 20, 2023
by
Martin Weise
Browse files
Options
Downloads
Patches
Plain Diff
Updated docs
parent
965fe67a
No related branches found
No related tags found
3 merge requests
!231
CI: Remove build for log-service
,
!228
Better error message handling in the frontend
,
!223
Release of version 1.4.0
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
.docs/system-services-upload.md
+55
-0
55 additions, 0 deletions
.docs/system-services-upload.md
docker-compose.prod.yml
+27
-1
27 additions, 1 deletion
docker-compose.prod.yml
mkdocs.yml
+1
-0
1 addition, 0 deletions
mkdocs.yml
with
83 additions
and
1 deletion
.docs/system-services-upload.md
0 → 100644
+
55
−
0
View file @
1f8dd40b
---
author
:
Martin Weise
---
# Upload Service
## tl;dr
!!! debug "Debug Information"
Image: [tusproject/tusd:v1.12`](https://hub.docker.com/r/tusproject/tusd)
* Ports: 1080/tcp
* Prometheus: `http://<hostname>:1080/api/upload/metrics`
* API: `http://<hostname>:1080/api/upload`
## Overview
We use the
[
TUS
](
https://tus.io/
)
open protocol for resumable file uploads which based entirely on HTTP.
### Examples
Upload a CSV-file into the
`dbrepo-upload`
bucket with the console
via
`http://<hostname>/admin/storage/browser/dbrepo-upload`
.
We recommend using a TUS-compatible client:
*
[
tus-java-client
](
https://github.com/tus/tus-java-client
)
(
Java
)
*
[
tus-js-client
](
https://github.com/tus/tus-js-client
)
(
JavaScript/Node.js
)
*
[
tusd
](
https://github.com/tus/tusd
)
(
Go
)
## Limitations
*
No support for authentication.
!!! question "Do you miss functionality? Do these limitations affect you?"
We strongly encourage you to help us implement it as we are welcoming contributors to open-source software and get
in [contact](../contact) with us, we happily answer requests for collaboration with attached CV and your programming
experience!
## Security
1.
We strongly encourage to limit the clients allowed to upload by adding your subnet, e.g.
`128.130.0.0/16`
(=TU Wien subnet) to the
[
Gateway Service
](
../system-services-gateway
)
configuration file like this:
```nginx title="dbrepo.conf"
location /api/upload {
allow 128.130.0.0/16;
deny all;
...
}
```
This diff is collapsed.
Click to expand it.
docker-compose.prod.yml
+
27
−
1
View file @
1f8dd40b
...
@@ -179,7 +179,7 @@ services:
...
@@ -179,7 +179,7 @@ services:
environment
:
environment
:
S3_STORAGE_ENDPOINT
:
"
${STORAGE_ENDPOINT:-http://storage-service:9000}"
S3_STORAGE_ENDPOINT
:
"
${STORAGE_ENDPOINT:-http://storage-service:9000}"
S3_ACCESS_KEY_ID
:
"
${STORAGE_USERNAME:-minioadmin}"
S3_ACCESS_KEY_ID
:
"
${STORAGE_USERNAME:-minioadmin}"
S3_SECRET_ACCESS_KEY
:
${STORAGE_PASSWORD:-minioadmin}
S3_SECRET_ACCESS_KEY
:
"
${STORAGE_PASSWORD:-minioadmin}
"
volumes
:
volumes
:
-
"
${SHARED_FILESYSTEM:-/tmp}:/tmp"
-
"
${SHARED_FILESYSTEM:-/tmp}:/tmp"
healthcheck
:
healthcheck
:
...
@@ -361,6 +361,32 @@ services:
...
@@ -361,6 +361,32 @@ services:
logging
:
logging
:
driver
:
json-file
driver
:
json-file
dbrepo-upload-service
:
restart
:
"
no"
container_name
:
dbrepo-upload-service
hostname
:
upload-service
image
:
docker.io/tusproject/tusd:v1.12
ports
:
-
"
1080:1080"
command
:
-
"
--base-path=/api/upload/files/"
-
"
-s3-endpoint=${STORAGE_ENDPOINT:-http://storage-service:9000}"
-
"
-s3-bucket=dbrepo-upload"
environment
:
AWS_ACCESS_KEY_ID
:
"
${STORAGE_USERNAME:-minioadmin}"
AWS_SECRET_ACCESS_KEY
:
"
${STORAGE_PASSWORD:-minioadmin}"
AWS_REGION
:
"
${STORAGE_REGION_NAME:-eu-west-1}"
depends_on
:
dbrepo-storage-service
:
condition
:
service_healthy
healthcheck
:
test
:
wget -qO- localhost:1080/metrics | grep "tusd" || exit
1
interval
:
10s
timeout
:
5s
retries
:
12
logging
:
driver
:
json-file
dbrepo-mirror-service
:
dbrepo-mirror-service
:
restart
:
"
no"
restart
:
"
no"
container_name
:
dbrepo-mirror-service
container_name
:
dbrepo-mirror-service
...
...
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
1
−
0
View file @
1f8dd40b
...
@@ -22,6 +22,7 @@ nav:
...
@@ -22,6 +22,7 @@ nav:
-
Data Service
:
system-services-data.md
-
Data Service
:
system-services-data.md
-
Metadata Service
:
system-services-metadata.md
-
Metadata Service
:
system-services-metadata.md
-
Mirror Service
:
system-services-mirror.md
-
Mirror Service
:
system-services-mirror.md
-
Upload Service
:
system-services-upload.md
-
Storage Service
:
system-services-storage.md
-
Storage Service
:
system-services-storage.md
-
Databases
:
-
Databases
:
-
Auth Database
:
system-databases-auth.md
-
Auth Database
:
system-databases-auth.md
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment