Windows Server

If you are just testing your app on your personal computer, you can use otree devserver. You don’t need a full server setup as described below, which is necessary for sharing your app with an audience.

This section is for people who are experienced with setting up web servers. If you would like an easier and quicker way, we recommend using Heroku.

Why do I need to install server software?

oTree’s development setup (using devserver with a SQLite database) is not designed for running actual studies. One known risk is that if you don’t install Postgres, your SQLite database might lock when multiple users are accessing it simultaneously.

For a short, small study, you might be able to get away with just using devserver, as long as you set up your IP address as described in Configure your computer to be a server and run otree collectstatic.

However, for reliable results, you should follow the steps below.

Upgrade oTree

Upgrade oTree, to get the latest bugfixes:

$ pip3 install -U otree

Database (Postgres)

oTree’s default database is SQLite, which is fine for local development, but insufficient for production, because it often locks when it multiple clients are accessing it.

We recommend you use PostgreSQL. Install Postgres for Windows, using the default options. Note down the password you chose for the root postgres user.

Launch pgAdmin (you can find it in your Windows Start menu), and using the browser, create a new database:

../_images/pgadmin.png

In the “Database” field, enter the name django_db.

Now, edit your pg_hba.conf, which is usually located in C:\Program Files\PostgreSQL\9.6\data or a similarly named folder. On the lines for IPv4 and IPv6, change the METHOD from md5 to trust.

Now, set your DATABASE_URL environment variable to this:

postgres://postgres@localhost/django_db

To set the environment variable, do a Windows search (or control panel search) for “environment variables”. This will take you to the dialog with a name like “Edit system environment variables”. Add a new system entry for DATABASE_URL with the above URL.

Then restart your Command Prompt so the environment variable gets loaded.

Once DATABASE_URL is defined, oTree will use it instead of the default SQLite. (This is done via dj_database_url.)

psycopg2

To use Postgres, you need to install psycopg2 with pip3 install psycopg2. If the pip install doesn’t work, download it here. (If you are using a virtualenv, note the special installation instructions on that page.)

resetdb

If all the above steps went well, you should be able to run otree resetdb.

Install Redis

You should download and run Redis for Windows.

Redis should be running on port 6379. You can test with redis-cli ping, which should output PONG.

Run the production server

Run:

otree runprodserver 80

See here for full instructions. The steps are essentially the same as on Linux.

Set environment variables

Now let’s set the variables that control security. You should set OTREE_ADMIN_PASSWORD, OTREE_PRODUCTION, and OTREE_AUTH_LEVEL.

Allow other computers to connect

See instructions here.

Next steps

See Server deployment: final steps for steps you should take before launching your study.

Advanced

(Optional) create a virtualenv

It’s a best practice to use a virtualenv (though optional):

python3 -m venv venv_otree

You can configure PowerShell to always activate this virtualenv. Enter:

notepad $shell

Then put this in the file:

cd "C:\path\to\oTree"
. "C:\path\to\oTree\venv_otree\Scripts\activate.ps1"

(Note the dot at the beginning of the line.)

(Optional) use git

The remaining steps are to deploy your code with Git as described here,