14 Commits

Author SHA1 Message Date
Sharif Nassar
0b377a76d0 Remove Vagrant docs
* Vagrant does not seem to have any libvirt boxes for Ubuntu any more.
* Vagrant 2 was released a year ago, but vagrant-libvirt only claims
  to support up to Vagrant 1.8.
2018-10-13 11:31:53 -07:00
Daniel Quinn
cd92c005e3 Add support for using pre-existing text from PDFs 2018-01-30 20:13:35 +00:00
Tido-
ac850b64aa minor changes on documentation files 2017-05-10 22:25:59 +02:00
Daniel Quinn
8fc3d8a27e Minor text edits. 2017-01-01 18:37:44 +00:00
Daniel Quinn
f16aa33fd9 s/*Paperless*/Paperless/g 2016-03-28 20:01:01 +01:00
Jaime Gómez
a366542ed9 Docs: fixes typos + clarifies troubleshotting section 2016-03-23 02:41:29 +01:00
Jaime Gómez
8115cf8905 Improves the docs: OCRing files in languages other than English + fixes typos 2016-03-21 21:57:36 +01:00
Steve Vandervalk
d288aece38 Add brew install libmagic to apple requirements.
`./manage.py migrate` ran into `raise ImportError('Unable to find magic library')` on latest Apple tastic.
2016-03-15 17:32:39 +10:00
Pit Kleyersburg
fb36a49c26 Add unpaper as another pre-processing step 2016-03-06 15:30:37 +01:00
Pit Kleyersburg
724afa59c7 Add Dockerfile for application and documentation
This commit adds a `Dockerfile` to the root of the project, accompanied
by a `docker-compose.yml.example` for simplified deployment. The
`Dockerfile` is agnostic to whether it will be the webserver, the
consumer, or if it is run for a one-off command (i.e. creation of a
superuser, migration of the database, document export, ...).

The containers entrypoint is the `scripts/docker-entrypoint.sh` script.
This script verifies that the required permissions are set, remaps the
default users and/or groups id if required and installs additional
languages if the user wishes to.

After initialization, it analyzes the command the user supplied:

  - If the command starts with a slash, it is expected that the user
    wants to execute a binary file and the command will be executed
    without further intervention. (Using `exec` to effectively replace
    the started shell-script and not have any reaping-issues.)

  - If the command does not start with a slash, the command will be
    passed directly to the `manage.py` script without further
    modification. (Again using `exec`.)

The default command is set to `--help`.

If the user wants to execute a command that is not meant for `manage.py`
but doesn't start with a slash, the Docker `--entrypoint` parameter can
be used to circumvent the mechanics of `docker-entrypoint.sh`.

Further information can be found in `docs/setup.rst` and in
`docs/migrating.rst`.

For additional convenience, a `Dockerfile` has been added to the `docs/`
directory which allows for easy building and serving of the
documentation. This is documented in `docs/requirements.rst`.
2016-02-18 22:58:32 +01:00
Daniel Quinn
2ed2d641b5 Added a note about the plight of Apple users. 2016-02-13 00:59:19 +00:00
Daniel Quinn
1d4b87ee46 Update for #22 2016-02-12 08:54:04 +00:00
Daniel Quinn
26d231752c Updated the README to point to rtfd 2016-01-24 20:29:41 -05:00
Daniel Quinn
286292dbf9 Added some documentation 2016-01-24 20:15:50 -05:00