Directories
¶
| Path | Synopsis |
|---|---|
|
Package acls defines a simple wrapper on top of casbin functions.
|
Package acls defines a simple wrapper on top of casbin functions. |
|
Package admin contains routes and tasks for Readeck admin.
|
Package admin contains routes and tasks for Readeck admin. |
|
Package app is Readeck main application.
|
Package app is Readeck main application. |
|
Package assets provides the HTTP routes that serve static files.
|
Package assets provides the HTTP routes that serve static files. |
|
Package auth defines Readeck's authentication providers.
|
Package auth defines Readeck's authentication providers. |
|
credentials
Package credentials contains the models and functions to manage user credentials.
|
Package credentials contains the models and functions to manage user credentials. |
|
onboarding
Package onboarding provides the routes and forms for the initial onboarding process.
|
Package onboarding provides the routes and forms for the initial onboarding process. |
|
signin
Package signin contains the routes for Readeck sign-in process.
|
Package signin contains the routes for Readeck sign-in process. |
|
tokens
Package tokens contains the models and functions to manage user API tokens.
|
Package tokens contains the models and functions to manage user API tokens. |
|
users
Package users contains the models and functions to manage users.
|
Package users contains the models and functions to manage users. |
|
Package bookmarks provides storage and tooling for bookmarks and collections management.
|
Package bookmarks provides storage and tooling for bookmarks and collections management. |
|
importer
Package importer provides the necessary tooling to import bookmarks from various sources.
|
Package importer provides the necessary tooling to import bookmarks from various sources. |
|
routes
Package routes provides http routes for bookmarks and collections management.
|
Package routes provides http routes for bookmarks and collections management. |
|
tasks
Package tasks contains the bookmark and collection related tasks.
|
Package tasks contains the bookmark and collection related tasks. |
|
Package bus provides Readeck's message bus and task executor.
|
Package bus provides Readeck's message bus and task executor. |
|
Package cookbook provides routes for testing and design previews.
|
Package cookbook provides routes for testing and design previews. |
|
Package dashboard provides routes for Readeck's dashboard.
|
Package dashboard provides routes for Readeck's dashboard. |
|
Package db provides the first layer interfaces to database storage.
|
Package db provides the first layer interfaces to database storage. |
|
filters
Package filters provides query filters for specific operations.
|
Package filters provides query filters for specific operations. |
|
types
Package types provides some shared database types.
|
Package types provides some shared database types. |
|
Package email provides functions to send emails.
|
Package email provides functions to send emails. |
|
Package metrics provides a prometheus/open-metrics route.
|
Package metrics provides a prometheus/open-metrics route. |
|
Package opds provides the routes for the OPDS catalogs.
|
Package opds provides the routes for the OPDS catalogs. |
|
catalog
Package catalog provides type to create an OPDS catalog of entries.
|
Package catalog provides type to create an OPDS catalog of entries. |
|
Package profile provides the user's profile management routes.
|
Package profile provides the user's profile management routes. |
|
Package searchstring provides a search string parser.
|
Package searchstring provides a search string parser. |
|
Package server is the main Readeck HTTP server.
|
Package server is the main Readeck HTTP server. |
|
Package sessions provides a cookie based session manager.
|
Package sessions provides a cookie based session manager. |
|
Package testing provides tools to tests the HTTP routes, the message bus, email sending, etc.
|
Package testing provides tools to tests the HTTP routes, the message bus, email sending, etc. |
|
Package videoplayer provides a route for an HLS embed video player.
|
Package videoplayer provides a route for an HLS embed video player. |
Click to show internal directories.
Click to hide internal directories.