Merge pull request #171 from labexp/version-1

Docker instalation

Author: 5up3rD4n1

.gitignore

@@ -1,10 +1,10 @@
 src/.idea/
-<<<<<<< HEAD
+
+
 **/__pycache__/
 src/services/main.py
 *.pyc
 *.mo
 .idea/
-=======
-**/__pycache__/
->>>>>>> upstream/master
+
+.envrc

Dockerfile

@@ -0,0 +1,30 @@
+FROM labexperimental/debian:jessie
+
+MAINTAINER LabExperimental <librescan@gmail.com>
+
+VOLUME /root/LibreScanProjects
+
+VOLUME /root/.librescan
+
+VOLUME /dev/bus/usb
+
+EXPOSE 8080
+
+ADD ./ /librescan
+
+WORKDIR /tmp
+
+RUN python3 -m venv ~/.virtualenvs/librescan && \
+    /bin/bash -c "source ~/.virtualenvs/librescan/bin/activate" && \
+    chmod +x /librescan/misc/chdkptp_dependency.sh && \
+    chmod +x /librescan/misc/docker-entry.sh && \
+    sh /librescan/misc/chdkptp_dependency.sh
+
+WORKDIR /librescan/src
+
+RUN pip install -r requirements.txt && \
+    python setup.py
+
+ENV LS_DEV_MODE=False
+
+ENTRYPOINT ["../misc/docker-entry.sh"]

README.md

@@ -3,15 +3,57 @@
 ## Comunidad
 - Hemos creado un bot de telegram para mantener a todos informados sobre los avances del proyecto, agrega el bot `@Librescan_bot` para recibir notificaciones. Creditos a nuestro amigo [Lupa18](https://github.com/lupa18) por nuestro bot de telegram! 
 
-## Instalación
+## Instalación con Docker (Recomenda)
 
-- Instalar dependencias que serán utilizadas:
+Por favor refierase a la documentación de docker para su instalación:
+ 
+- https://docs.docker.com/install
+- [How can I use docker without sudo?](https://askubuntu.com/a/477554)
 
-		# apt-get install python3-pip lua5.2 liblua5.2 git-svn libusb-dev python3 python-dev libjpeg8 libffi-dev libturbojpeg1-dev
+Una vez instalado `docker` basta con correr el comando:
+
+```bash
+docker run -d -p 8080:8080 --privileged --name librescan \
+-v ~/LibreScanProjects:/root/LibreScanProjects \
+-v ~/.librescan:/root/.librescan \
+-v /dev/bus/usb:/dev/bus/usb \
+labexperimental/librescan:v1.2.0
+```
+
+Después de correr el comando encontará dos nuevas carpetas en su directorio `HOME`:
+
+- `~/LibreScanProjects`: Dirección donde se almacenan los proyectos e imágenes.
+- `~/.librescan`: Dirección donde se almacena la configuración general de LS.
+
+Una vez creado el contenedor de librescan no es necesario volver a correr el comando anterior,
+puede utilizar los siguientes comandos para administrar el contenedor:
+
+- Ejecute el siguiente comando para detener el contenedor:
+    
+      docker container stop librescan  
+
+- Ejecute el siguiente comando para volver a iniciar el contenedor cuando lo desee:
+    
+      docker container start librescan 
+
+## Instalación Manual
+
+### ! Nota importante antes de iniciar
+
+Este tipo de instalación está sujeta a cambios dependiendo la distribución de linux que el usuario
+tenga en su computador, recomendamos intentar instalar la version de docker donde hemos
+preparado todo para su correcto funcionamiento.
+
+Si desea continuar con la instalación manual, algunas de las versiones mencionadas pueden variar
+con el tiempo o la distribución de linux. Si encuentra algún problema durante la instalación puede
+abrir un issue o bien diriguirse a nuestro canal de Telegram para recibir ayuda.
 
-		# pip3 install pyYAML bottle pyjade jinja2 polib cffi pexpect
 
-		# pip3 install jpegtran-cffi==0.5.2
+### Instrucciones
+
+- Instalar dependencias que serán utilizadas:
+
+		# apt-get install python3-pip lua5.2 liblua5.2 git-svn libusb-dev python3 python-dev libjpeg8 libffi-dev libturbojpeg1-dev
 
 --------------------------------------------------------------------------------------------
 
@@ -42,40 +84,42 @@
 		# apt-get install ruby ruby-dev ruby-rmagick 
 		# gem install iconv pdfbeads
 
+	Nota: Si presenta errores al instalar pdfbeads relacionados con zlib, instalar:
+
+		# apt-get install zlib1g-dev
 
 --------------------------------------------------------------------------------------------
 - En cuanto a las cámaras hay que instalar el CHDKPTP en el sistema.
 
-		$ git svn clone http://subversion.assembla.com/svn/chdkptp/trunk chdkptp
+		$ git clone https://github.com/svn2github/chdkptp.git
 
 		$ cd chdkptp
 
-    -- nota: al 01.02.2015 Checked out HEAD:
-       http://subversion.assembla.com/svn/chdkptp/trunk r694
-
 		$ mv config-sample-linux.mk config.mk
 
 		$ make
 
 		# mkdir /usr/bin/chdkptp
 
-		# cp chdkptp-sample.sh /usr/bin/chdkptp/chdkptp
+		# cp chdkptp.sh /usr/bin/chdkptp/chdkptp
 
-      -- nota: chdkptp-sample.sh está en la dirección donde se descargó el chdkptp.
+      -- nota: chdkptp.sh está en la dirección donde se descargó el chdkptp.
 
 		# nano /usr/bin/chdkptp/chdkptp
 
-Modificar la línea que dice
-
-    #CHDKPTP_DIR=/path/to/chdkptp
-
-por: 
-	
-	CHDKPTP_DIR=<FolderClonado>/chdkptp (Y guardamos los cambios)
-
-nota: <FolderClonado>/chdkptp es la dirección donde se haya clonado el chdkptp (en el primer paso de esta sección). 
-
-		# ln -s /usr/bin/chdkptp/chdkptp /bin
+    Modificar la línea que dice
+    
+      CHDKPTP_EXE=chdkptp
+      CHDKPTP_DIR=/path/to/chdkptp
+    
+    por:
+    
+      CHDKPTP_EXE=chdkptp.sh
+      CHDKPTP_DIR=<ubicación del folder clonado de chdkptp> (Y guardamos los cambios)
+    
+    nota: <FolderClonado>/chdkptp es la dirección donde se haya clonado el chdkptp (en el primer paso de esta sección). 
+    
+      # ln -s /usr/bin/chdkptp/chdkptp /bin
 
 --------------------------------------------------------------------------------------------
 - Es necesario tener CHDK instalado en las cámaras. (En caso de no tenerlo se puede seguir esta guía. Se recomienda usar el método "a"): 
@@ -100,12 +144,16 @@ Nota: Estamos trabajando en automatizar este proceso, de modo que se el usuario
 
 		$ cd LibreScan/src
 
+- Instalamos las dependencias de Python
+        
+      $ pip3 install -r requirements.txt
+
 - Corremos el setup para la creación de carpetas y archivos de configuración.
 
-		$ python3.4 setup.py
+      $ python3 setup.py
 		
 - Para ejecutar la aplicación web
 
-		$ python3.4 main.py web
+		$ python3 main.py web
 
-- Por último, abrimos el navegador en http://0.0.0.0:8180
+- Por último, abrimos el navegador en http://0.0.0.0:8080