From 0b377a76d01376e3303c97d7c6a51613ca0f48e8 Mon Sep 17 00:00:00 2001 From: Sharif Nassar Date: Sat, 13 Oct 2018 11:31:53 -0700 Subject: [PATCH] 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. --- .gitignore | 1 - Vagrantfile | 20 ------------- docs/requirements.rst | 2 +- docs/setup.rst | 61 +-------------------------------------- docs/troubleshooting.rst | 5 ++-- scripts/vagrant-provision | 31 -------------------- 6 files changed, 4 insertions(+), 116 deletions(-) delete mode 100644 Vagrantfile delete mode 100644 scripts/vagrant-provision diff --git a/.gitignore b/.gitignore index 439d9df4b..cf485e15f 100644 --- a/.gitignore +++ b/.gitignore @@ -73,7 +73,6 @@ db.sqlite3 # Other stuff that doesn't belong .virtualenv virtualenv -.vagrant docker-compose.yml docker-compose.env diff --git a/Vagrantfile b/Vagrantfile deleted file mode 100644 index 46caa38bc..000000000 --- a/Vagrantfile +++ /dev/null @@ -1,20 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : - -VAGRANT_API_VERSION = "2" -Vagrant.configure(VAGRANT_API_VERSION) do |config| - config.vm.box = "ubuntu/trusty64" - - # Provision using shell - config.vm.host_name = "dev.paperless" - config.vm.synced_folder ".", "/opt/paperless" - config.vm.provision "shell", path: "scripts/vagrant-provision" - - # Networking details - config.vm.network "private_network", ip: "172.28.128.4" - - config.vm.provider "virtualbox" do |vb| - # Customize the amount of memory on the VM: - vb.memory = "1024" - end -end diff --git a/docs/requirements.rst b/docs/requirements.rst index ee42cb96a..b6cbad213 100644 --- a/docs/requirements.rst +++ b/docs/requirements.rst @@ -33,7 +33,7 @@ In addition to the above, there are a number of Python requirements, all of which are listed in a file called ``requirements.txt`` in the project root directory. -If you're not working on a virtual environment (like Vagrant or Docker), you +If you're not working on a virtual environment (like Docker), you should probably be using a virtualenv, but that's your call. The reasons why you might choose a virtualenv or not aren't really within the scope of this document. Needless to say if you don't know what a virtualenv is, you should diff --git a/docs/setup.rst b/docs/setup.rst index 2dcfeb901..d794c663b 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -42,18 +42,14 @@ Installation & Configuration You can go multiple routes with setting up and running Paperless: * The `bare metal route`_ - * The `vagrant route`_ * The `docker route`_ -The `Vagrant route`_ is quick & easy, but means you're running a VM which comes -with memory consumption, cpu overhead etc. The `docker route`_ offers the same -simplicity as Vagrant with lower resource consumption. +The `docker route`_ is quick & easy. The `bare metal route`_ is a bit more complicated to setup but makes it easier should you want to contribute some code back. -.. _Vagrant route: setup-installation-vagrant_ .. _docker route: setup-installation-docker_ .. _bare metal route: setup-installation-bare-metal_ .. _Docker Machine: https://docs.docker.com/machine/ @@ -267,54 +263,6 @@ Docker Method newer ``docker-compose.yml.example`` file -.. _setup-installation-vagrant: - -Vagrant Method -++++++++++++++ - -1. Install `Vagrant`_. How you do that is really between you and your OS. -2. Run ``vagrant up``. An instance will start up for you. When it's ready and - provisioned... -3. Run ``vagrant ssh`` and once inside your new vagrant box, edit - ``/etc/paperless.conf`` and set the values for: - - * ``PAPERLESS_CONSUMPTION_DIR``: This is where your documents will be - dumped to be consumed by Paperless. - * ``PAPERLESS_PASSPHRASE``: This is the passphrase Paperless uses to - encrypt/decrypt the original document. It's only required if you want - your original files to be encrypted, otherwise, just leave it unset. - * ``PAPERLESS_EMAIL_SECRET``: this is the "magic word" used when consuming - documents from mail or via the API. If you don't use either, leaving it - blank is just fine. - -4. Exit the vagrant box and re-enter it with ``vagrant ssh`` again. This - updates the environment to make use of the changes you made to the config - file. -5. Initialise the database with ``/opt/paperless/src/manage.py migrate``. -6. Still inside your vagrant box, create a user for your Paperless instance - with ``/opt/paperless/src/manage.py createsuperuser``. Follow the prompts to - create your user. -7. Start the webserver with - ``/opt/paperless/src/manage.py runserver 0.0.0.0:8000``. You should now be - able to visit your (empty) `Paperless webserver`_ at ``172.28.128.4:8000``. - You can login with the user/pass you created in #6. -8. In a separate window, run ``vagrant ssh`` again, but this time once inside - your vagrant instance, you should start the consumer script with - ``/opt/paperless/src/manage.py document_consumer``. -9. Scan something. Put it in the ``CONSUMPTION_DIR``. -10. Wait a few minutes -11. Visit the document list on your webserver, and it should be there, indexed - and downloadable. - -.. caution:: - - This installation is not secure. Once everything is working head up to - `Making things more permanent`_ - -.. _Vagrant: https://vagrantup.com/ -.. _Paperless server: http://172.28.128.4:8000 - - .. _setup-permanent: Making Things a Little more Permanent @@ -513,13 +461,6 @@ second period. .. _Upstart: http://upstart.ubuntu.com/ -Vagrant -~~~~~~~ - -You may use the Ubuntu explanation above. Replace -``(local-filesystems and net-device-up IFACE=eth0)`` with ``vagrant-mounted``. - - .. _setup-permanent-docker: Docker diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 268235923..05b314004 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -14,9 +14,8 @@ FORGIVING_OCR is enabled``, then you might need to install the `Tesseract language files `_ marching your document's languages. -As an example, if you are running Paperless from the Vagrant setup provided -(or from any Ubuntu or Debian box), and your documents are written in Spanish -you may need to run:: +As an example, if you are running Paperless from any Ubuntu or Debian +box, and your documents are written in Spanish you may need to run:: apt-get install -y tesseract-ocr-spa diff --git a/scripts/vagrant-provision b/scripts/vagrant-provision deleted file mode 100644 index 940bf476c..000000000 --- a/scripts/vagrant-provision +++ /dev/null @@ -1,31 +0,0 @@ -#!/bin/bash - -# Install packages -apt-get update -apt-get build-dep -y python-imaging -apt-get install -y libjpeg8 libjpeg62-dev libfreetype6 libfreetype6-dev -apt-get install -y build-essential python3-dev python3-pip sqlite3 libsqlite3-dev git -apt-get install -y tesseract-ocr tesseract-ocr-eng imagemagick unpaper - -# Python dependencies -pip3 install -r /opt/paperless/requirements.txt - -# Create the environment file -cat /opt/paperless/paperless.conf.example | sed -e 's#CONSUMPTION_DIR=""#CONSUMPTION_DIR="/home/vagrant/consumption"#' > /etc/paperless.conf -chmod 0640 /etc/paperless.conf -chown root:vagrant /etc/paperless.conf - -# Create the consumption directory -mkdir /home/vagrant/consumption -chown vagrant:vagrant /home/vagrant/consumption - -echo " - - -Now follow the remaining steps in the Vagrant section of the setup -documentation to complete the process: - -http://paperless.readthedocs.org/en/latest/setup.html#setup-installation-vagrant - - -"