Commit Graph

56 Commits

Author SHA1 Message Date
Jonas Winkler 9187026c47 removed some stuff 2020-10-25 20:52:39 +01:00
Frederick Robinson 2a94e3a648 Adjust docker version requirements in doc
The default config uses docker compose version 2.1 

https://docs.docker.com/compose/compose-file/compose-versioning/#version-21
2020-06-02 00:20:58 -07:00
Fabian Winter 9c1fcbcc98 Address comments 2019-11-03 20:14:17 +01:00
Fabian Winter 9b2b435c5b Support SSL for web interface
Thanks to @MasterofJOKers, here is basic support for SSL:
You need to create your key and certificate and copy them to the `data`
directory, named `ssl.cert` and `ssl.key`.
Then, set `PAPERLESS_USE_SSL` in `docker-compose.env` to `true`.

Solves #576.
2019-11-03 18:30:43 +01:00
Matthias Brandt 12f0df0f52 fix: Documentation rendering leads to wrong commands #569 2019-10-05 18:08:06 +02:00
Pit ebd9f918d2 Merge pull request #543 from maur/master
lxc installation - small improvements
2019-09-08 19:13:03 +02:00
Florian Gabsteiger 82855f9d43 Adjust path in setup docs to python 3.6 as 3.4 is deprecated 2019-08-10 17:25:52 +02:00
Florian Gabsteiger 7e77c5ec31 Add static file collection instruction to bare-metal setup guide as it is necessary for whitenoise static file serving 2019-07-25 00:55:20 +02:00
Piotr Cichosz fb15d897b3 Merge branch 'master' into master 2019-05-27 00:28:22 +02:00
Piotr Cichosz 0eb073b6d2 change urls to the-paperless-project repo 2019-05-27 00:18:37 +02:00
Piotr Cichosz 467bb013e2 check if lxc-install executed as root 2019-05-27 00:04:57 +02:00
Piotr Cichosz 1f1a23d19f changed urls for my fork - for easier testing
changed sed separator as suggested in https://github.com/the-paperless-project/paperless/pull/500#discussion_r257806300
2019-05-25 19:02:34 +02:00
jenspfeifle 362570ca0d update links to reflect move to the-paperless-project 2019-03-05 21:54:59 +01:00
bmsleight f135ed12b0 scripts/lxc into docs/examples/lxc/ and assumption noted 2019-01-27 15:16:19 +00:00
Brendan M. Sleight 4ed5c55782 Merge pull request #1 from danielquinn/master
rebase to upstream
2019-01-27 14:02:22 +00:00
Daniel Quinn a58a7ce0f7 Move note about DEBUG up into 3. 2019-01-27 13:03:55 +00:00
Daniel Quinn 792aeee11e Merge pull request #487 from bmsleight/issue486
Add note runserver PAPERLESS_DEBUG='true'
2019-01-27 13:00:37 +00:00
bmsleight 5e674f17af Add note runserver PAPERLESS_DEBUG='true' 2019-01-26 13:15:45 +00:00
Brian Cribbs 7c7a814096 adding information about NFS mounts and inotify 2019-01-22 15:18:14 -05:00
bmsleight f74313f3ab Adding lxc documentation 2019-01-20 21:19:43 +00:00
Joshua Taillon 597a7bb391 Update setup.rst
The provided `gunicorn` command did not work for me, failing with the following error:

```
ModuleNotFoundError: No module named '/home/paperless/paperless/src/paperless' 
```

The solution was to provide only `paperless.wsgi` as the argument to `gunicorn`, and provide a flag for `--pythonpath`. After changing it to this, the server started up fine.
2018-11-16 09:20:08 -05:00
Dean Perry 81e488b90d added missing ; to nginx config 2018-10-31 12:39:48 +00:00
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 24d3e7f9d3 Merge @ovv's documentation changes and tweak the grammar a bit 2018-07-08 22:14:17 +01:00
Daniel Quinn a0240cace3 Update docs for new encryption toggle 2018-06-17 17:08:24 +01:00
Ovv 6fd9995aa1 Installation documentation setup
Issue #329
2018-04-25 19:51:21 +02:00
Erik Arvstedt 1f2079f65a 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 f778d3a6e3 Remove last remnants of PAPERLESS_SHARED_SECRET 2018-03-18 14:08:41 +00:00
Rida Ayed abbd4d772c Update setup.rst
Fixed typo
2018-03-04 16:30:29 +01:00
Daniel Quinn 506af7c9c2 Conform to an 80-character limit 2018-02-03 15:26:09 +00:00
Daniel Quinn abf01be889 Move the Docker method up 2018-02-03 14:22:10 +00:00
Daniel Quinn e900a38983 Update docs to reflect Docker changes 2018-01-30 17:19:18 +00:00
Guy e20b4fb905 fixing typos and rst syntax 2018-01-29 23:41:52 +02:00
Guy cbbc4d37d0 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 5cbb33b02b Add documentation for the new FORCE_SCRIPT_NAME feature 2017-09-09 12:21:31 +03:00
MasterofJOKers 167412a003 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 4198de604f 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 34bab04310 fix: formatting cleanup 2017-05-10 17:38:00 -07: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
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