1327 Commits

Author SHA1 Message Date
Daniel Quinn
e149baec4e Update for #53 2016-02-23 20:30:33 +00:00
Daniel Quinn
0d46643026 Version bump 2016-02-21 01:24:30 +00:00
Daniel Quinn
5c6aa201be Merge pull request #50 from tikitu/docker-tweaks
Some small tweaks to the Docker setup and documentation
2016-02-20 00:06:12 +00:00
Tikitu de Jager
438b161a25 Move docker-compose.env to docker-compose.env.example & adjust docs
This file, like `docker-compose.yml`, should be edited by the user. To
avoid merge conflicts when pulling updates, the edited version should
not be committed to the repository.
2016-02-19 22:51:49 +02:00
Tikitu de Jager
147f8f72a2 Simplify instructions for exporting with docker
The export workflow reusing the `/consume` volume is complex and error-
prone, and not at all necessary if the `docker-compose.yml` file has a
volume for `/export` from the beginning.
2016-02-19 22:27:48 +02:00
Daniel Quinn
3a8755e4c8 Document the retagger
Fixes #54
2016-02-19 17:26:40 +00: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
5de4951a46 Added a screenshot, now I have to figure out how to put it in the readme. 2016-02-16 09:08:35 +00:00
Daniel Quinn
aea4af5d3b Version bump and feature update 2016-02-14 17:18:28 +00:00
Pit Kleyersburg
20b2408dbb Ensure OCR_THREADS is integer, add documentation 2016-02-14 16:37:38 +01:00
Daniel Quinn
6b0a537bff Added support for a shared secret in email 2016-02-14 03:01:24 +00:00
Daniel Quinn
cec9968cdb Documented consumption 2016-02-14 00:10:49 +00:00
Daniel Quinn
294f104474 Merge branch 'master' into feature/images-as-docs 2016-02-13 01:01:10 +00:00
Daniel Quinn
68fa7d68fa Merge branch 'master' of github.com:danielquinn/paperless 2016-02-13 00:59:36 +00:00
Daniel Quinn
2ed2d641b5 Added a note about the plight of Apple users. 2016-02-13 00:59:19 +00:00
Steve Atkins
a4903049a3 Document cloning from public URL rather than ssh 2016-02-12 11:36:07 -08:00
Daniel Quinn
9ed8a2b2d7 Merge branch 'master' into feature/images-as-docs 2016-02-12 09:03:46 +00:00
Daniel Quinn
1d4b87ee46 Update for #22 2016-02-12 08:54:04 +00:00
Daniel Quinn
78ee138ad7 Added migration and changelog updates 2016-02-11 12:25:00 +00:00
Daniel Quinn
cf4c437eca Be a little more verbose about the passphrase 2016-01-29 23:40:57 +00:00
Joshua Taillon
a983d7390a Clarify how to start server on a different port/ip 2016-01-29 18:26:50 -05:00
Daniel Quinn
d6f4ef27aa Added pytz requirement 2016-01-28 08:22:33 +00:00
Daniel Quinn
a7d041a9f5 Prettied-up the admin 2016-01-28 08:16:29 +00:00
Daniel Quinn
3026593d6c Version bump for automated tagging 2016-01-28 07:29:25 +00:00
Daniel Quinn
da50bc1cc6 formatting 2016-01-24 20:41:58 -05: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