Hosting ======= Let's see how would you run thumbor in different environments. Development Environment ----------------------- For running it locally you just need to get a proper :doc:`configuration` file. You can put it at ``/etc/thumbor.conf``, ``~/thumbor.conf`` (home folder) or specify it when starting thumbor. To verify if you have thumbor, just type: .. code:: bash thumbor --version It should return the version you've installed. Starting thumbor is as easy as: .. code:: bash thumbor For more options check the :doc:`configuration` page. Production Environment ---------------------- Other than having the proper :doc:`configuration` file for your environment, we have some recommendations on how to run thumbor in production. Our first recommendation is to run more than one instance of it. You can specify different ports using thumbor easily. This will make sure that your service stays responsive even if one of the processes die. We also recommend having some form of load balance that distributes the load between the aforementioned processes. We are using NGINX to do it, but there are more sophisticated load balance softwares around. thumbor supports health checking under the ``/healthcheck`` URI if you need to use it. Other than that, you run it using the thumbor console app specifying the arguments, like this: .. code:: bash thumbor --port=8888 --conf="~/mythumbor.conf" We recommend using an application such as Supervisor (http://supervisord.org/index.html) to monitor your services. An example of a ``supervisord.conf`` file would be: .. code:: [supervisord] logfile = /home/thumbor/logs/supervisord.log logfile_maxbytes = 50MB logfile_backups=10 loglevel = info pidfile = /home/thumbor/supervisord.pid user = thumbor [program:thumbor] command=thumbor --port=800%(process_num)s --conf=/etc/thumbor800%(process_num)s.conf process_name=thumbor800%(process_num)s numprocs=4 user=thumbor directory=/home/thumbor/ autostart=true autorestart=true startretries=3 stopsignal=TERM stdout_logfile=/home/thumbor/logs/thumbor800%(process_num)s.stdout.log stdout_logfile_maxbytes=1MB stdout_logfile_backups=10 stderr_logfile=/home/thumbor/logs/thumbor800%(process_num)s.stderr.log stderr_logfile_maxbytes=1MB stderr_logfile_backups=10 This configuration file makes sure that supervisor starts 4 processes of thumbor on the 8000, 8001, 8002 and 8003 ports, each with a different configuration file (thumbor8000.conf, thumbor8001.conf, thumbor8002.conf, thumbor8003.conf all under /etc folder). The other settings are optional, but if you need help with supervisor's settings it has extensive documentation online (http://supervisord.org/introduction.html). Thumbor in the Cloud -------------------- Running with Docker ~~~~~~~~~~~~~~~~~~~ Running thumbor with an official Docker image is very straightforward. An official image is built and hosted on GitHub Container Registry. .. code:: bash docker run -p 8888:8888 ghcr.io/thumbor/thumbor:latest To verify thumbor is running, you can check the health endpoint: .. code:: bash curl http://localhost:8888/healthcheck For more information about the official Docker image, visit the `GitHub Container Registry `_. Configuring the Docker Image ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Thumbor can be configured in Docker using environment variables or config files. **Environment Variables** Use the ``THUMBOR_`` prefix to set configuration options: .. code:: bash docker run -p 8888:8888 \ -e THUMBOR_SECURITY_KEY=my-secret-key \ -e THUMBOR_QUALITY=85 \ ghcr.io/thumbor/thumbor:latest **Configuration File** Mount a config file for complex configurations: .. code:: bash docker run -p 8888:8888 \ -v /path/to/thumbor.conf:/etc/thumbor/thumbor.conf \ ghcr.io/thumbor/thumbor:latest Generate a template config with ``thumbor-config > thumbor.conf``. For more detailed configuration options, see the :doc:`configuration` documentation. .. TODO:: update this instructions as they are severely outdated Creating your thumbor install in heroku ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can deploy and test Thumbor in the cloud. It's quite easy with `Heroku `__ : - Create an account like described at http://devcenter.heroku.com/articles/quickstart - Install the heroku Toolbelt as described in the same page - Log to Heroku in your shell - Create a small git project for the configuration of your Thumbor instance. The whole script to deploy and start an instance : .. code:: bash mkdir heroku cd heroku/ echo "thumbor>=2.7.0" >> requirements.txt # let heroku deploy and compile prerequisite package via PIP echo "web: thumbor -p $PORT" >> Procfile # listening port is automatically affected at deployment (we use here the default config) git init git add . git commit -m "init" heroku create --stack cedar git push heroku master Basically, adding thumbor in requirements.txt will install everything you need on Heroku, and you just need to run thumbor -p $PORT to run thumbor on Heroku. In order to run process on Heroku, you need to write down the command in Procfile. Procfile looks like following (make sure there are no "" inside both files): :: $ cat Procfile web: thumbor -p $PORT Your heroku folder (or whatever you named, I named it thumbor) should look like following (only contains two files): :: ~/thumbor(master)$ ls Procfile requirements.txt - Start the instance (Remember: 1 heroku web instance is free of charges, so don't try with more yet): heroku scale web=1 - Verify your new instance is up (in the case of our sample project is stormy-stone-5336.herokuapp.com): heroku ps - Now if you point your browser to the server name, you'll get a 404 HTTP Error. Just try with an URL that thumbor understands. To open your web browser pointing to the new server: heroku open - Then try something like: ``_ (notice there is no listening port specified) If you need to scale thumbor server, read more about it in Heroku's documentation. The sample implementation for the above links can be found at https://github.com/heynemann/thumbor-heroku and is open-source and MIT Licensed. Another Thumbor/Heroku configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `This blog post `__ and the attached repositories (`Jetpack `__ and `thumbor-heroku `__) explain a more advanced Heroku deployment, that support the ``smart`` URL feature. Thumbor on OpenShift -------------------- .. warning:: This may be outdated since thumbor moved to python 3. There's a project showing how to deploy a working version on `OpenShift `__ https://github.com/rafaelcaricio/thumbor-openshift-example Thumbor behind CloudFront ------------------------- .. warning:: This may be outdated since thumbor moved to python 3. The awesome people at `yipit `__ are using thumbor behind the CloudFront `CDN `__ at Amazon. The detailed information on how to do it can be seen at `this blog post `__.