Code Monkey home page Code Monkey logo

documentation's Introduction

Papermerge DMS Documentation

Papermerge DMS documentation is based on mkdocs material.

Online Version

Papermerge DMS documentation is available online at https://docs.papermerge.io/

How to Use

Make sure you have installed python and poetry, then in root repository folder run following commands:

$ poetry install
$ poetry run mkdocs serve

Above commands will install all dependencies, switch into environment variable and run documentation in auto build mode. Any change in documentation repository will be automatically rebuild.

Multi-versions

For each Papermerge major version there is separate repository branch in this repository.

  • Papermerge version 2.0.x docs are in git branch v2.0
  • Papermerge version 2.1.x docs are in git branch v2.1
  • Papermerge version 3.0.x docs are in git branch v3.0
  • etc

documentation's People

Contributors

ajarzyn avatar ciur avatar dvonessen avatar github-actions[bot] avatar mrtango avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

documentation's Issues

OIDC Documentation

It has been a month since OIDC has been added to the software, can we please get documentation for how to do this? Even just the basics would be helpful, what are the Env vars?

how to migrate from latest stable 2.0.1 to 2.1-dev

Upgrading only describes how to upgrade from 1.5.x to 2.x

In example docker-compose.yml database also changed from sqlite3 to postgres. If i manually backup from 2.0.1 sqlite3
python manage.py dumpdata --exclude=contenttypes > backup.json

and then try to restore in 2.1-dev with postgres
python manage.py loaddata backup.json

i got this error
Traceback (most recent call last): File "/venv/lib/python3.9/site-packages/django/db/models/options.py", line 608, in get_field return self.fields_map[field_name] KeyError: 'file_name'

Which database migrations needs to be applied before to be able to update?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.