SampleDB
SampleDB is a web-based sample and measurement metadata database.
Documentation
You can find the documentation for the current release at https://scientific-it-systems.iffgit.fz-juelich.de/SampleDB/.
Getting Started
We recommend using our pre-built Docker images for setting up SampleDB. You will need two containers, one for a PostgreSQL database and another for SampleDB itself, and a directory to store all files in.
If you would like to set up a development version of SampleDB instead, please see the contribution guide.
If you do not have Docker installed yet, please install Docker.
Using docker-compose
First, get the docker-compose.yml configuration file. You can git clone this repo or just get the file:
curl https://raw.githubusercontent.com/sciapp/sampledb/develop/docker-compose.yml --output docker-compose.yml
Then simply bring everything up with:
docker-compose up -d
Using docker commands
First, start your database container:
docker run \
-d \
-e POSTGRES_PASSWORD=password \
-e PGDATA=/var/lib/postgresql/data/pgdata \
-v `pwd`/pgdata:/var/lib/postgresql/data/pgdata:rw \
--restart=always \
--name sampledb-postgres \
postgres:12
Next, start the SampleDB container:
docker run \
-d \
--link sampledb-postgres \
-e SAMPLEDB_CONTACT_EMAIL=sampledb@example.com \
-e SAMPLEDB_MAIL_SERVER=mail.example.com \
-e SAMPLEDB_MAIL_SENDER=sampledb@example.com \
-e SAMPLEDB_ADMIN_PASSWORD=password \
-e SAMPLEDB_SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://postgres:password@sampledb-postgres:5432/postgres \
-e SAMPLEDB_FILE_STORAGE_PATH=/home/sampledb/files/ \
-v `pwd`/files:/home/sampledb/files:rw \
--restart=always \
--name sampledb \
-p 8000:8000 \
sciapp/sampledb:0.20.0
Once it's started
This will start a minimal SampleDB installation at http://localhost:8000 and allow you to sign in with the username admin and the password password (which you should change immediately after signing in).
To learn how to further set up SampleDB, please follow the rest of the Getting Started guide.
Contributing
If you want to improve SampleDB, please read the contribution guide for a few notes on how to report issues or submit changes.
Support
If you have any questions about SampleDB or run into any issues setting up or running SampleDB, please open an issue on GitHub.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sampledb-0.20.0.tar.gz.
File metadata
- Download URL: sampledb-0.20.0.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b6a7beaeff79b7e58ebee68e26482901e3687b5710534603258674e6f4217daa
|
|
| MD5 |
e3207af2253443c5a8d8064f5e936a16
|
|
| BLAKE2b-256 |
cee7c54036f0e41cf80ac2d836f5210b33248c9fea8ce9011512bcd110de8a9b
|
