librarian

module

v0.2.11 Latest Latest Go to latest Published: Sep 25, 2024 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tuihub/librarian

Links

Open Source Insights

README ¶

Librarian

Librarian is the standard server implementation of TuiHub.

It is recommended to use with the standard client implementation Waiter. Check document site for user guide.

Usage

Server binary

Build the server with make, or download the binary file in releases page.

Config file

Config file is required. The config template is provided in configs

Command line arguments

config path, eg: --conf config.yaml
data path, eg: --data /opt/librarian/data

Environment variables

LOG_LEVEL, accept debug, info, warn, error
DEMO_MODE, accept true, false, server will reject any changes on admin user when demo mode is enabled
CREATE_ADMIN_USER, accept a string
CREATE_ADMIN_PASS, accept a string, server will create the given admin user on startup

Development

Install Go
(Optional) Install Docker and Docker Compose
(Optional) Deploy dependencies with tests/docker-compose.yml
Create the config file at configs/config.yaml with templates.
Run make run to start the server

Directories ¶

Path	Synopsis
app
mapper/cmd/mapper command
mapper/internal/biz
mapper/internal/data
mapper/internal/server
mapper/internal/service
mapper/pkg/service
miner/cmd/miner command
miner/internal/biz
miner/internal/data
miner/internal/server
miner/internal/service
miner/pkg/service
searcher/cmd/searcher command
searcher/internal/biz
searcher/internal/data
searcher/internal/server
searcher/internal/service
searcher/pkg/service
sephirah/cmd/sephirah command
sephirah/internal/biz
sephirah/internal/biz/bizangela
sephirah/internal/biz/bizbinah
sephirah/internal/biz/bizchesed
sephirah/internal/biz/bizgebura
sephirah/internal/biz/biznetzach
sephirah/internal/biz/biztiphereth
sephirah/internal/biz/bizutils
sephirah/internal/biz/bizyesod
sephirah/internal/client
sephirah/internal/data
sephirah/internal/data/internal/converter
sephirah/internal/data/internal/ent
sephirah/internal/data/internal/ent/account
sephirah/internal/data/internal/ent/app
sephirah/internal/data/internal/ent/appbinary
sephirah/internal/data/internal/ent/appinfo
sephirah/internal/data/internal/ent/appinst
sephirah/internal/data/internal/ent/appinstruntime
sephirah/internal/data/internal/ent/deviceinfo
sephirah/internal/data/internal/ent/enttest
sephirah/internal/data/internal/ent/feed
sephirah/internal/data/internal/ent/feedactionset
sephirah/internal/data/internal/ent/feedconfig
sephirah/internal/data/internal/ent/feedconfigaction
sephirah/internal/data/internal/ent/feeditem
sephirah/internal/data/internal/ent/feeditemcollection
sephirah/internal/data/internal/ent/file
sephirah/internal/data/internal/ent/hook
sephirah/internal/data/internal/ent/image
sephirah/internal/data/internal/ent/migrate
sephirah/internal/data/internal/ent/notifyflow
sephirah/internal/data/internal/ent/notifyflowsource
sephirah/internal/data/internal/ent/notifyflowtarget
sephirah/internal/data/internal/ent/notifysource
sephirah/internal/data/internal/ent/notifytarget
sephirah/internal/data/internal/ent/portercontext
sephirah/internal/data/internal/ent/porterinstance
sephirah/internal/data/internal/ent/predicate
sephirah/internal/data/internal/ent/runtime
sephirah/internal/data/internal/ent/schema
sephirah/internal/data/internal/ent/systemnotification
sephirah/internal/data/internal/ent/tag
sephirah/internal/data/internal/ent/user
sephirah/internal/data/internal/ent/userdevice
sephirah/internal/data/internal/ent/usersession
sephirah/internal/model/converter
sephirah/internal/model/modelangela
sephirah/internal/model/modelbinah
sephirah/internal/model/modelchesed
sephirah/internal/model/modelgebura
sephirah/internal/model/modelnetzach
sephirah/internal/model/modelsupervisor
sephirah/internal/model/modeltiphereth
sephirah/internal/model/modelyesod
sephirah/internal/service
sephirah/internal/supervisor
sephirah/pkg/service
cmd
librarian command
internal
client
conf
inprocgrpc
lib/libapp
lib/libauth
lib/libcache
lib/libcodec
lib/libcron
lib/libmq
lib/libobserve
lib/libsentry
lib/libtime
lib/libtype
lib/libzap
lib/logger
model
model/modelfeed
server
tests
client command
fakes3 command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL