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.
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.11.0
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
Metadata
1 maintainer
Release files for sampledb 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sampledb-0.11.0.tar.gz | 1.5 MB | Details |
Release files / sampledb-0.11.0.tar.gz
| Download URL | sampledb-0.11.0.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c14b48ba210f8b9c40695f64e62fe4e94dc28f762a82b51adb35eb3c289494c
|
|
BLAKE2b-256 checksum How to use checksums |
721c9da756c03dfc56c00f0a045de266627778367381f9386c6052fe0f6cfca6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7
|
