130 Commits

Author SHA1 Message Date
Erik Arvstedt
7157ed2bdd Use --noreload for permanent server start commands
Without it, the server is highly resource-intensive even when
running idle
2018-03-23 11:13:20 +01:00
Daniel Quinn
748128c8c3 Remove last remnants of PAPERLESS_SHARED_SECRET 2018-03-18 14:08:41 +00:00
Rida Ayed
b82c05d4d2 Update setup.rst
Fixed typo
2018-03-04 16:30:29 +01:00
Daniel Quinn
62e9c8390a Conform to an 80-character limit 2018-02-03 15:26:09 +00:00
Daniel Quinn
7f253cfb20 Move the Docker method up 2018-02-03 14:22:10 +00:00
Daniel Quinn
d40cb9569b Update docs to reflect Docker changes 2018-01-30 17:19:18 +00:00
Guy
902b66bd82 fixing typos and rst syntax 2018-01-29 23:41:52 +02:00
Guy
76d8d9806b Updated Dockerfile with maintainer and contributors
Updated setup.rst with information on upgrade path if coming from an
earlier version of docker-compose images
2018-01-29 23:19:06 +02:00
Daniel Quinn
dae63e11cc Add documentation for the new FORCE_SCRIPT_NAME feature 2017-09-09 12:21:31 +03:00
MasterofJOKers
94c24137c7 Mention "collectstatic" in the docs
When using the built-in webserver in debug mode, the static files are
handled automatically. From the Django docs:

	During development, if you use django.contrib.staticfiles, this will
	be done automatically by runserver when DEBUG is set to True (see
	django.contrib.staticfiles.views.serve()).

	This method is grossly inefficient and probably insecure, so it is
	unsuitable for production.

This means, when using a real webserver, it also has to serve the static
files, i.e.  CSS and JavaScript. For that, one needs to run `./manage.py
collectstatic` first.
2017-06-26 17:08:37 +02:00
David Martin
7881bd4078 Copy Paperless service files to systemd directory before enabling them.
The problem with the original instruction is that systemd creates a
symlink pointing to the service file in the paperless directory. A user
is unlikely to leave the changes in the service files committed
(especially not on a master branch checkout) and they are easily lost and
the services fail to start without obvious reason.

To avoid this we simply copy the service files to the systemd directory
directly and use the files in the repository only as an example.
2017-05-24 22:48:35 +10:00
Daniel Quinn
a21e64e98e fix: formatting cleanup 2017-05-10 17:38:00 -07:00
Tido-
d87dc5848b 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
Ruben Waterman
b6b39049a9 Update setup.rst
Added a line on how to use the ubuntu upstart example in Vagrant. It took me hours to figure out why it wouldn't start on boot but would when you would type "start paperless-server" manually. The start on vagrant-mounted solved the problem, so I thought it would be good to share this with the paperless community.
2016-08-27 00:56:14 +02:00
Daniel Quinn
c5aafdb43d Added some configs for Apache & Nginx/gunicorn 2016-08-21 10:44:52 +01:00
Ivan Smirnov
d4b2fa43e4 Incorporated feedback from upstream PR
Resolved comments in danielquinn/paperless#116
2016-04-27 21:43:09 -07:00
Ivan Smirnov
715f4fcc97 Update setup flow for bare metal with systemd
The default files assume a specific path on the target system. Added a note letting people know they need to edit the files. Also fixed a bug with enabling the service - it caused odd errors on my system. Tested on Centos 7.
2016-04-13 22:26:57 -07:00
Daniel Quinn
3250c47408 rst vs md makes me sad 2016-03-19 12:26:19 +00:00
Daniel Quinn
d29e91eb70 Removed references to editing settings.py and cleaned up formatting 2016-03-19 12:20:36 +00:00
Jean Snyman
5d2eb05edb Add directions for automatic starting at bootup on Ubuntu 14.04 2016-03-19 01:57:54 -07:00
Daniel Quinn
13c2ed66e1 Better bare metal explanation 2016-03-04 17:53:54 +00:00
Daniel Quinn
dd3bdcb956 Updated the Vagrant tools to use environment variables 2016-03-03 11:00:46 +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
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
Pit Kleyersburg
20b2408dbb Ensure OCR_THREADS is integer, add documentation 2016-02-14 16:37:38 +01:00
Steve Atkins
a4903049a3 Document cloning from public URL rather than ssh 2016-02-12 11:36:07 -08: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
286292dbf9 Added some documentation 2016-01-24 20:15:50 -05:00