<commit_before>.. _install-docs:

Installation
============

Linux + Docker
--------------

1. Install Docker_.
2. Pull the image::

       $ sudo docker pull scrapinghub/splash

3. Start the container::

       $ sudo docker run -p 5023:5023 -p 8050:8050 -p 8051:8051 scrapinghub/splash

4. Splash is now available at 0.0.0.0 at ports
   8050 (http), 8051 (https) and 5023 (telnet).

OS X + Docker
-------------

1. Install Docker_ (via the Toolbox Instructions_).
2. Run the Docker Machine & load its environment

       $ docker-machine start default
       
       $ eval "$(docker-machine env default)"

2. Pull the image::

       $ docker pull scrapinghub/splash

3. Start the container::

       $ docker run -p 5023:5023 -p 8050:8050 -p 8051:8051 scrapinghub/splash

4. Figure out the ip address of the docker-machine::

       $ docker-machine ip default 

       192.168.59.103

5. Splash is available at the returned IP address at ports
   8050 (http), 8051 (https) and 5023 (telnet).

.. _Docker: http://docker.io
.. _Instructions: https://docs.docker.com/mac/


.. _manual-install-ubuntu:

Ubuntu 14.04 (manual way)
-------------------------

1. Install system dependencies (check<commit_msg>Doc: add instruction to create the docker-machine<commit_after>.. _install-docs:

Installation
============

Linux + Docker
--------------

1. Install Docker_.
2. Pull the image::

       $ sudo docker pull scrapinghub/splash

3. Start the container::

       $ sudo docker run -p 5023:5023 -p 8050:8050 -p 8051:8051 scrapinghub/splash

4. Splash is now available at 0.0.0.0 at ports
   8050 (http), 8051 (https) and 5023 (telnet).

OS X + Docker
-------------

1. Install Docker_ (via the Toolbox Instructions_).
2. Create, run & load the configuration for the docker-machine

       $ docker-machine create default
       
       $ docker-machine start default
       
       $ eval "$(docker-machine env default)"

2. Pull the image::

       $ docker pull scrapinghub/splash

3. Start the container::

       $ docker run -p 5023:5023 -p 8050:8050 -p 8051:8051 scrapinghub/splash

4. Figure out the ip address of the docker-machine::

       $ docker-machine ip default 

       192.168.59.103

5. Splash is available at the returned IP address at ports
   8050 (http), 8051 (https) and 5023 (telnet).

.. _Docker: http://docker.io
.. _Instructions: https://docs.docker.com/mac/


.. _manual-install-ubuntu:

Ubuntu 14.04 (manual way)
-------------------------

1. Install system dependencies (check
{'fraction_non_alphanumeric': 0.14507772020725387, 'fraction_numerical': 0.0813072937425269, 'mean_word_length': 2.4010840108401084, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 4, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5475592', 'n_tokens_mistral': 962, 'n_tokens_neox': 759, 'n_words': 281}