Keeper core API
Your personal content curation service.
This project is the core system of Nunux Keeper. It's an API that allow you to collect, organize, and retrieve online documents.
- Create text or HTML documents (from scratch, from an URL or from an uploaded file)
- Cleaning web pages for better readability
- Edit document content
- Attach files to a document
- Full Text search on documents
- Create labels (name, color)
- Classify documents with labels
- Remove and restore documents
- Share documents with other users or publicly
- Expose public documents with RSS
- Import and Export documents of an user
- RESTFul API (with HATOAS support)
- Authentication delegated to external identity provider (like Keycloak, Auth0, ...)
- Store attachments on disk or on S3
- Online API documentation
- Produce metrics (with StatsD)
- Publish server event to external systems (with Webhooks, AMQP, ...)
- BDD testing (with Cucumber)
ROADMAP.md for planned features.
Under the hood
The indexation engine is also pluggable, but only Elasticsearch is supported for now.
Redis is used as an event bus to exchange data between services.
- [Docker compose][docker-compose]
# Start required backends (ElasticSearch, MongoDB, Redis) # Launch tests # Teardown backends make build deploy test undeploy
You can also launch tests using Elasticsearch as main database:
make build deploy with-elastic test undeploy
Start the server
Warning: This is useful for testing or have a development server. If you want to operate the service and don't lost your data please refer below.
# Start required backends (ElasticSearch, MongoDB, Redis) and the API server. # (Using dev configuration: etc/default/dev.env) make with-app deploy logs
If you want to start the server with another configuration (for instance:
staging) you need to override the
env variable of the
make with-app deploy env=staging
Configuration files are located into the
See etc/default/dev.env for development configuration
Finally you can remove everything like this:
# Stop and destroy all services make undeploy
Install the server as a service
You need to have all backend services up and running with following Docker names:
# Install systemd configuration (for staging env) make install env=staging
Un-install is as simple:
Started services are:
- keeper-core-api: Core API server.
- keeper-core-job-worker: Job worker to process background tasks
- keeper-data-backup: Backup documents files (scheduler).
Copyright (c) 2016 Nicolas CARLIER (https://github.com/ncarlier)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.