Our goal is to implement an external document management service to hold and provide uploaded documents. Documents can be uploaded and, depending on user access, managed by internal as well as external users.
The goal is NOT to re implement a complex DMS but rather to have a simple and user-friendly way of managing documents with different permissions.
All User Interface interactions should be as simple as possible and easily understandable.
Original RFC that led to alexandria
Requirements
- docker
- docker-compose
After installing and configuring those, download docker-compose.yml and run the following command:
docker-compose up -dYou can now access the api at http://localhost:8000/api/v1/.
Document Merge Service is a 12factor app which means that configuration is stored in environment variables. Different environment variable types are explained at django-environ.
A list of configuration options which you need
SECRET_KEY: A secret key used for cryptography. This needs to be a random string of a certain length. See more.ALLOWED_HOSTS: A list of hosts/domains your service will be served from. See more.DATABASE_ENGINE: Database backend to use. See more. (default: django.db.backends.postgresql)DATABASE_HOST: Host to use when connecting to database (default: localhost)DATABASE_PORT: Port to use when connecting to database (default: 5432)DATABASE_NAME: Name of database to use (default: alexandria)DATABASE_USER: Username to use when connecting to the database (default: alexandria)DATABASE_PASSWORD: Password to use when connecting to database
Look at our contributing guidelines to start with your first contribution.