Testbed-WebAPI: https://shepherd.cfaed.tu-dresden.de:8000
Main Documentation: https://orgua.github.io/shepherd
Source Code: https://github.com/orgua/shepherd-webservice
Main Project: https://github.com/orgua/shepherd
The Webservice links the user to the testbed. It's written in Python and uses FastAPI to expose an interface to the internet. You can write your own tools or just use the testbed-client integrated in the Core-Datalib.
Internally the webservices utilizes the herd-lib to access the shepherd observers. Handling of data is done with Pydantic-Models that store the actual data in a database.
- DNS approved for the server: shepherd.cfaed.tu-dresden.de
- Port 8000 requested for firewall passing
- SSL-Certificate per LetsEncrypt -> alternative is <www.sectigo.com>
- bring demo-application online
- add https to FastAPI
- TODO: allow service to start with reduced rights -> get nfs in order (access needs elevation)
- data validation for python dataclasses, its fast, elegantly designed and comes with batteries included
- already trusted base for shepherd-datalib
- restful web-framework based on pydantic2 & fastapi
- still alpha, but usable, rapid updates
- plan B: tbd
- stable and lots to offer, but maybe limited for more
- and there is a freemium service
- high performance web framework for APIs based on pydantic
- offers features like OAuth, SSL-Encryption (by uvicorn), user-sessions
- choice for now
- low level but stable framework
- async & pydantic-based ODM or MongoDB
- stable, but also actively developed
- choice for now
- async & pydantic-based ODM for SQLAlchemy
- still alpha, very slow in development
- has trouble with complex pydantic-models
- async & pydantic-based ODM for SQLAlchemy
- currently limited to pydantic <v2 -> dealbreaker
- Secrets-Management
- Server-Monitoring, remote alerting
- sentry-sdk,
- set up a local MongoDB instance
- install package
- config .env, by either bringing in a backup or starting fresh
- backup: repopulate database by using ´shepherd_wsrv init file´
- fresh start: generate fresh salt and initialize database with
shepherd_wsrv init
shepherd_wsrv run
or to switch to the offline-mode activate the redirect to the docs
shepherd_wsrv redirect
shepherd_wsrv backup file_name