- install docker
- install docker-compose
- clone this repo
- install the systemd files [optional]
choose an IP your deployment should use, usually that will be the IP of your host.
choose a secret to be used for inter-service authentication.
Update the .env file accordingly
Run docker-compose up -d --build
Point your browser to the IP you chose,
login by providing any username and valid e-mail.
A little write-up on this setup:
https://medium.com/@nikosch86/getting-started-with-automated-in-house-testing-on-android-smartphones-using-stf-dafecee4a8ee
If you clap it will make me happy :)
Additional work was done in the original code to facilitate a greater degree of configuration to the docker-compose.yml. More specifically, the following configuration environment variables were added:
- OPENSTF_VERSION - the tag of the devicefarmer/stf docker image to use
- ADB_VERSION - the tag of the sorccu/adb docker image to use
- ADB_KEY_PATH - the path to the adb keys
- RETHINKDB_VERSION - the tag of the rethinkdb docker image to use
- RETHINKDB_DATA_PATH - the path to the
rethinkdb_datathat contains the rethinkdb data - HTTP_PORT - the HTTP port to bind the http server to
- PROVIDER_MIN_PORT - the provider starting port range that will be exposed
- PROVIDER_MAX_PORT - the provider ending port range that will be exposed
- AUTH_TYPE - the authentication mechanism to use. Defaults to auth-mock. It has been successfully tested with auth-oauth2, as discussed here
- AUTH_URL - the auth URL of the STF server
- OAUTH_AUTHORIZATION_URL - the authorization URL of the OAuth2 server.
- OAUTH_TOKEN_URL - the OAuth2 server from which a valid OAuth2 token can be retrieved
- OAUTH_USERINFO_URL - the OAuth2 URL from which to retrieve the user information
- OAUTH_CLIENT_ID - the OAuth2 client id
- OAUTH_CLIENT_SECRET - the OAuth2 secret
- OAUTH_CALLBACK_URL - the Device farmer callback URL where the OAuth2 server will redirect logged-in users to
- OAUTH_SCOPE - the OAuth2 scopes
WARNING The variables used for configuring the individual docker image versions, should be docker tags and not docker image ids.
Copy the file systemd/docker-compose@.service to your /etc/systemd/system folder. Note that the docker-compose installation used
for development was performed according to the instructions found in the official Docker documentation.
As such, the systemd service, assumes that the docker service upon which it depends, is called docker.service and the docker-compose binary is located in /usr/local/bin/docker-compose . You should update the systemd file,
if your installation differs. Furthermore, the systemd file was created according the discussion found in this issue
and can be used to run other docker-compose based services (it is trivial to modify it to work for this docker-compose installation only). You should
also run systemctl daemon-reload at this point.
Create the folder /etc/docker/compose/stf-app and copy the following files/folders:
- the docker-compose.yml file
- the .env file (change it accordingly)
- the nginx folder
- the storage-temp folder
You should be able to control the service with the following commands:
systemctl [start|stop|restart|status] docker-compose@stf-app