{"action":"created","comment":{"url":"https://api.github.com/repos/ove/ove-docs/pulls/comments/237153872","pull_request_review_id":179379984,"id":237153872,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzNzE1Mzg3Mg==","diff_hunk":"@@ -0,0 +1,265 @@\n+# Installing OVE\n+\n+OVE needs to be installed before it can be used to control a display. OVE can be installed either by downloading and compiling the source code of the corresponding components or by running a specific installer available on the [**OVE Install**](https://github.com/ove/ove-install/) repository.\n+\n+All contributors to OVE are encouraged to download and compile the source code. All users of OVE are encouraged to use the OVE installers.\n+\n+## Installation by running OVE installers\n+\n+[**OVE Install**](https://github.com/ove/ove-install/) scripts are designed to install OVE into a [Docker](https://www.docker.com/get-started) environment.\n+\n+### Prerequisites\n+\n+* [git](https://git-scm.com/downloads)\n+* [Docker](https://www.docker.com/get-started)\n+* [Docker Compose](https://docs.docker.com/compose/install/)\n+\n+### Configuring the environment\n+\n+The deployment environment needs to be pre-configured before running the OVE installers. This involves setting up ports and environment variables.\n+\n+The ports are pre-configured to a list of common defaults, but can be changed based on end-user requirements. Each port or port-range is defined as a mapping `HOST_PORT:CONTAINER_PORT`. Only the host ports can be changed, and it is important to note that **container ports must not be changed**.\n+\n+#### Environment variables\n+\n+Before installing OVE you must configure the environment variables:\n+\n+* `OVE_HOST` - Hostname (or IP address) + port of OVE core\n+* `TUORIS_HOST` - Hostname (or IP address) + port of the [Tuoris](https://github.com/fvictor/tuoris) service (dependency of SVG application).\n+\n+Before installing [**OVE Asset Services**](https://github.com/ove/ove-asset-services) you must configure the environment variables:\n+\n+* `MYSQL_RANDOM_ROOT_PASSWORD` - This variable is mandatory and we recommend it be set to `yes`. This will generate a random initial password for the root user on the [MariaDB](https://mariadb.org/) database.\n+* `MYSQL_DATABASE` - The name of the [MariaDB](https://mariadb.org/) database which defaults to `AssetDatabase`.\n+* `MYSQL_USER` - The username used to connect to the MariaDB database which defaults to `assetManager`.\n+* `MYSQL_PASSWORD` - The username used to connect to the [MariaDB](https://mariadb.org/) database which defaults to `assetManager`.\n+* `s3Client__AccessKey` - The access key used to connect to the [S3](https://www.nuget.org/packages/Amazon.S3/) compliant object storage as described in the [Asset Manager documentation](https://github.com/ove/ove-asset-services/blob/master/packages/ove-asset-manager/README.md#configuration).\n+* `s3Client__Secret` - The secret used to connect to the [S3](https://www.nuget.org/packages/Amazon.S3/) compliant object storage as described in the [Asset Manager documentation](https://github.com/ove/ove-asset-services/blob/master/packages/ove-asset-manager/README.md#configuration).\n+* `s3Client__ServiceURL` - The service URL of the [S3](https://www.nuget.org/packages/Amazon.S3/) compliant object storage as described in the [Asset Manager documentation](https://github.com/ove/ove-asset-services/blob/master/packages/ove-asset-manager/README.md#configuration).\n+* `ServiceHostUrl` - Hostname (or IP address) + port of the corresponding Asset Management Service.\n+* `MariaDB__ConnectionString` - The connection string used by the [Asset Manager](https://github.com/ove/ove-asset-services/tree/master/packages/ove-asset-manager) to connect to [MariaDB](https://mariadb.org/) database. The format of the connection string must always be similar to what is provided, but the port number, database name, username and password must change accordingly if their default values were changed.\n+* `AssetManagerHostUrl` - Hostname (or IP address) + port of the [Asset Manager](https://github.com/ove/ove-asset-services/tree/master/packages/ove-asset-manager).\n+\n+### Starting and stopping OVE\n+\n+OVE provides separate installation scripts to help users install the necessary components. To install and start OVE on Docker run:\n+\n+```sh\n+docker-compose -f docker-compose.ove.yml up -d\n+```\n+\n+Replace the `-d` option above with `--no-start` if you want to install OVE but do not want to start it at the end of the installation process.","path":"docs/INSTALLATION.md","position":51,"original_position":51,"commit_id":"da72b9a60fe84905d5118248b64f6a2a06e9da6f","original_commit_id":"da72b9a60fe84905d5118248b64f6a2a06e9da6f","user":{"login":"DavidAkroyd","id":1260383,"node_id":"MDQ6VXNlcjEyNjAzODM=","avatar_url":"https://avatars0.githubusercontent.com/u/1260383?v=4","gravatar_id":"","url":"https://api.github.com/users/DavidAkroyd","html_url":"https://github.com/DavidAkroyd","followers_url":"https://api.github.com/users/DavidAkroyd/followers","following_url":"https://api.github.com/users/DavidAkroyd/following{/other_user}","gists_url":"https://api.github.com/users/DavidAkroyd/gists{/gist_id}","starred_url":"https://api.github.com/users/DavidAkroyd/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DavidAkroyd/subscriptions","organizations_url":"https://api.github.com/users/DavidAkroyd/orgs","repos_url":"https://api.github.com/users/DavidAkroyd/repos","events_url":"https://api.github.com/users/DavidAkroyd/events{/privacy}","received_events_url":"https://api.github.com/users/DavidAkroyd/received_events","type":"User","site_admin":false},"body":"Personally I would actually use the --no-start option as default, with a `docker run` command, and include the auto-start as an alternative","created_at":"2018-11-28T16:14:08Z","updated_at":"2018-11-28T16:53:48Z","html_url":"https://github.com/ove/ove-docs/pull/11#discussion_r237153872","pull_request_url":"https://api.github.com/repos/ove/ove-docs/pulls/11","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/ove/ove-docs/pulls/comments/237153872"},"html":{"href":"https://github.com/ove/ove-docs/pull/11#discussion_r237153872"},"pull_request":{"href":"https://api.github.com/repos/ove/ove-docs/pulls/11"}},"in_reply_to_id":237152482},"pull_request":{"url":"https://api.github.com/repos/ove/ove-docs/pulls/11","id":234111150,"node_id":"MDExOlB1bGxSZXF1ZXN0MjM0MTExMTUw","html_url":"https://github.com/ove/ove-docs/pull/11","diff_url":"https://github.com/ove/ove-docs/pull/11.diff","patch_url":"https://github.com/ove/ove-docs/pull/11.patch","issue_url":"https://api.github.com/repos/ove/ove-docs/issues/11","number":11,"state":"open","locked":false,"title":"Improved Installation Guide for OVE","user":{"login":"senakafdo","id":3415383,"node_id":"MDQ6VXNlcjM0MTUzODM=","avatar_url":"https://avatars3.githubusercontent.com/u/3415383?v=4","gravatar_id":"","url":"https://api.github.com/users/senakafdo","html_url":"https://github.com/senakafdo","followers_url":"https://api.github.com/users/senakafdo/followers","following_url":"https://api.github.com/users/senakafdo/following{/other_user}","gists_url":"https://api.github.com/users/senakafdo/gists{/gist_id}","starred_url":"https://api.github.com/users/senakafdo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/senakafdo/subscriptions","organizations_url":"https://api.github.com/users/senakafdo/orgs","repos_url":"https://api.github.com/users/senakafdo/repos","events_url":"https://api.github.com/users/senakafdo/events{/privacy}","received_events_url":"https://api.github.com/users/senakafdo/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-11-28T00:46:41Z","updated_at":"2018-11-28T16:53:48Z","closed_at":null,"merged_at":null,"merge_commit_sha":"f397d12a9f7c9a2db8d6e75ece60a845ff31ab60","assignee":null,"assignees":[],"requested_reviewers":[{"login":"miguems","id":4958981,"node_id":"MDQ6VXNlcjQ5NTg5ODE=","avatar_url":"https://avatars3.githubusercontent.com/u/4958981?v=4","gravatar_id":"","url":"https://api.github.com/users/miguems","html_url":"https://github.com/miguems","followers_url":"https://api.github.com/users/miguems/followers","following_url":"https://api.github.com/users/miguems/following{/other_user}","gists_url":"https://api.github.com/users/miguems/gists{/gist_id}","starred_url":"https://api.github.com/users/miguems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/miguems/subscriptions","organizations_url":"https://api.github.com/users/miguems/orgs","repos_url":"https://api.github.com/users/miguems/repos","events_url":"https://api.github.com/users/miguems/events{/privacy}","received_events_url":"https://api.github.com/users/miguems/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ove/ove-docs/pulls/11/commits","review_comments_url":"https://api.github.com/repos/ove/ove-docs/pulls/11/comments","review_comment_url":"https://api.github.com/repos/ove/ove-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ove/ove-docs/issues/11/comments","statuses_url":"https://api.github.com/repos/ove/ove-docs/statuses/da72b9a60fe84905d5118248b64f6a2a06e9da6f","head":{"label":"ove:issue-6","ref":"issue-6","sha":"da72b9a60fe84905d5118248b64f6a2a06e9da6f","user":{"login":"ove","id":43252891,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQzMjUyODkx","avatar_url":"https://avatars2.githubusercontent.com/u/43252891?v=4","gravatar_id":"","url":"https://api.github.com/users/ove","html_url":"https://github.com/ove","followers_url":"https://api.github.com/users/ove/followers","following_url":"https://api.github.com/users/ove/following{/other_user}","gists_url":"https://api.github.com/users/ove/gists{/gist_id}","starred_url":"https://api.github.com/users/ove/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ove/subscriptions","organizations_url":"https://api.github.com/users/ove/orgs","repos_url":"https://api.github.com/users/ove/repos","events_url":"https://api.github.com/users/ove/events{/privacy}","received_events_url":"https://api.github.com/users/ove/received_events","type":"Organization","site_admin":false},"repo":{"id":151309507,"node_id":"MDEwOlJlcG9zaXRvcnkxNTEzMDk1MDc=","name":"ove-docs","full_name":"ove/ove-docs","private":false,"owner":{"login":"ove","id":43252891,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQzMjUyODkx","avatar_url":"https://avatars2.githubusercontent.com/u/43252891?v=4","gravatar_id":"","url":"https://api.github.com/users/ove","html_url":"https://github.com/ove","followers_url":"https://api.github.com/users/ove/followers","following_url":"https://api.github.com/users/ove/following{/other_user}","gists_url":"https://api.github.com/users/ove/gists{/gist_id}","starred_url":"https://api.github.com/users/ove/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ove/subscriptions","organizations_url":"https://api.github.com/users/ove/orgs","repos_url":"https://api.github.com/users/ove/repos","events_url":"https://api.github.com/users/ove/events{/privacy}","received_events_url":"https://api.github.com/users/ove/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/ove/ove-docs","description":"Documentation repository for OVE","fork":false,"url":"https://api.github.com/repos/ove/ove-docs","forks_url":"https://api.github.com/repos/ove/ove-docs/forks","keys_url":"https://api.github.com/repos/ove/ove-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ove/ove-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ove/ove-docs/teams","hooks_url":"https://api.github.com/repos/ove/ove-docs/hooks","issue_events_url":"https://api.github.com/repos/ove/ove-docs/issues/events{/number}","events_url":"https://api.github.com/repos/ove/ove-docs/events","assignees_url":"https://api.github.com/repos/ove/ove-docs/assignees{/user}","branches_url":"https://api.github.com/repos/ove/ove-docs/branches{/branch}","tags_url":"https://api.github.com/repos/ove/ove-docs/tags","blobs_url":"https://api.github.com/repos/ove/ove-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ove/ove-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ove/ove-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/ove/ove-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ove/ove-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/ove/ove-docs/languages","stargazers_url":"https://api.github.com/repos/ove/ove-docs/stargazers","contributors_url":"https://api.github.com/repos/ove/ove-docs/contributors","subscribers_url":"https://api.github.com/repos/ove/ove-docs/subscribers","subscription_url":"https://api.github.com/repos/ove/ove-docs/subscription","commits_url":"https://api.github.com/repos/ove/ove-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/ove/ove-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/ove/ove-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/ove/ove-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/ove/ove-docs/contents/{+path}","compare_url":"https://api.github.com/repos/ove/ove-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ove/ove-docs/merges","archive_url":"https://api.github.com/repos/ove/ove-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ove/ove-docs/downloads","issues_url":"https://api.github.com/repos/ove/ove-docs/issues{/number}","pulls_url":"https://api.github.com/repos/ove/ove-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/ove/ove-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/ove/ove-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ove/ove-docs/labels{/name}","releases_url":"https://api.github.com/repos/ove/ove-docs/releases{/id}","deployments_url":"https://api.github.com/repos/ove/ove-docs/deployments","created_at":"2018-10-02T19:14:50Z","updated_at":"2018-11-27T12:09:31Z","pushed_at":"2018-11-28T15:20:36Z","git_url":"git://github.com/ove/ove-docs.git","ssh_url":"git@github.com:ove/ove-docs.git","clone_url":"https://github.com/ove/ove-docs.git","svn_url":"https://github.com/ove/ove-docs","homepage":"","size":5675,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":4,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":0,"open_issues":4,"watchers":0,"default_branch":"master"}},"base":{"label":"ove:master","ref":"master","sha":"120e3fc598f9e69828ad515f988d9320fad74155","user":{"login":"ove","id":43252891,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQzMjUyODkx","avatar_url":"https://avatars2.githubusercontent.com/u/43252891?v=4","gravatar_id":"","url":"https://api.github.com/users/ove","html_url":"https://github.com/ove","followers_url":"https://api.github.com/users/ove/followers","following_url":"https://api.github.com/users/ove/following{/other_user}","gists_url":"https://api.github.com/users/ove/gists{/gist_id}","starred_url":"https://api.github.com/users/ove/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ove/subscriptions","organizations_url":"https://api.github.com/users/ove/orgs","repos_url":"https://api.github.com/users/ove/repos","events_url":"https://api.github.com/users/ove/events{/privacy}","received_events_url":"https://api.github.com/users/ove/received_events","type":"Organization","site_admin":false},"repo":{"id":151309507,"node_id":"MDEwOlJlcG9zaXRvcnkxNTEzMDk1MDc=","name":"ove-docs","full_name":"ove/ove-docs","private":false,"owner":{"login":"ove","id":43252891,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQzMjUyODkx","avatar_url":"https://avatars2.githubusercontent.com/u/43252891?v=4","gravatar_id":"","url":"https://api.github.com/users/ove","html_url":"https://github.com/ove","followers_url":"https://api.github.com/users/ove/followers","following_url":"https://api.github.com/users/ove/following{/other_user}","gists_url":"https://api.github.com/users/ove/gists{/gist_id}","starred_url":"https://api.github.com/users/ove/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ove/subscriptions","organizations_url":"https://api.github.com/users/ove/orgs","repos_url":"https://api.github.com/users/ove/repos","events_url":"https://api.github.com/users/ove/events{/privacy}","received_events_url":"https://api.github.com/users/ove/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/ove/ove-docs","description":"Documentation repository for OVE","fork":false,"url":"https://api.github.com/repos/ove/ove-docs","forks_url":"https://api.github.com/repos/ove/ove-docs/forks","keys_url":"https://api.github.com/repos/ove/ove-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ove/ove-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ove/ove-docs/teams","hooks_url":"https://api.github.com/repos/ove/ove-docs/hooks","issue_events_url":"https://api.github.com/repos/ove/ove-docs/issues/events{/number}","events_url":"https://api.github.com/repos/ove/ove-docs/events","assignees_url":"https://api.github.com/repos/ove/ove-docs/assignees{/user}","branches_url":"https://api.github.com/repos/ove/ove-docs/branches{/branch}","tags_url":"https://api.github.com/repos/ove/ove-docs/tags","blobs_url":"https://api.github.com/repos/ove/ove-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ove/ove-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ove/ove-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/ove/ove-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ove/ove-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/ove/ove-docs/languages","stargazers_url":"https://api.github.com/repos/ove/ove-docs/stargazers","contributors_url":"https://api.github.com/repos/ove/ove-docs/contributors","subscribers_url":"https://api.github.com/repos/ove/ove-docs/subscribers","subscription_url":"https://api.github.com/repos/ove/ove-docs/subscription","commits_url":"https://api.github.com/repos/ove/ove-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/ove/ove-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/ove/ove-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/ove/ove-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/ove/ove-docs/contents/{+path}","compare_url":"https://api.github.com/repos/ove/ove-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ove/ove-docs/merges","archive_url":"https://api.github.com/repos/ove/ove-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ove/ove-docs/downloads","issues_url":"https://api.github.com/repos/ove/ove-docs/issues{/number}","pulls_url":"https://api.github.com/repos/ove/ove-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/ove/ove-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/ove/ove-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ove/ove-docs/labels{/name}","releases_url":"https://api.github.com/repos/ove/ove-docs/releases{/id}","deployments_url":"https://api.github.com/repos/ove/ove-docs/deployments","created_at":"2018-10-02T19:14:50Z","updated_at":"2018-11-27T12:09:31Z","pushed_at":"2018-11-28T15:20:36Z","git_url":"git://github.com/ove/ove-docs.git","ssh_url":"git@github.com:ove/ove-docs.git","clone_url":"https://github.com/ove/ove-docs.git","svn_url":"https://github.com/ove/ove-docs","homepage":"","size":5675,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":4,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":0,"open_issues":4,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ove/ove-docs/pulls/11"},"html":{"href":"https://github.com/ove/ove-docs/pull/11"},"issue":{"href":"https://api.github.com/repos/ove/ove-docs/issues/11"},"comments":{"href":"https://api.github.com/repos/ove/ove-docs/issues/11/comments"},"review_comments":{"href":"https://api.github.com/repos/ove/ove-docs/pulls/11/comments"},"review_comment":{"href":"https://api.github.com/repos/ove/ove-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ove/ove-docs/pulls/11/commits"},"statuses":{"href":"https://api.github.com/repos/ove/ove-docs/statuses/da72b9a60fe84905d5118248b64f6a2a06e9da6f"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"DavidAkroyd"}}