{"action":"created","comment":{"url":"https://api.github.com/repos/3scale/apicast/pulls/comments/90616324","pull_request_review_id":11134717,"id":90616324,"diff_hunk":"@@ -0,0 +1,142 @@\n+# APIcast Overview\r\n+\r\n+APIcast is an NGINX based API gateway used to integrate your internal and external API services with 3scale’s API Management Platform.\r\n+\r\n+Here you’ll learn more about deployment options, environments provided, and how to get started.\r\n+\r\n+## Deployment options\r\n+\r\n+You can use APIcast hosted or self-managed, in both cases, it needs connection to the rest of the 3scale API management platform:\r\n+- **<a href=\"https://support.3scale.net/docs/deployment-options/apicast-cloud-gateway\">APIcast hosted</a>**: 3scale hosts the gateway in the cloud. The API gateway is already deployed for you and it's limited to 50,000 calls per day.\r\n+- **APIcast self-managed**: You can deploy APIcast wherever you want. To do so, download the json configuration file from API > Integration > Production or fetch it using the Account management API. The self-managed mode is the intended mode of operation for production environments. Here are a few recommended options to deploy your API gateway:\r\n+  - <a href=\"https://support.3scale.net/docs/deployment-options/nginx-self-managed-setup\">Local deploy</a>: Where the customer needs to deploy a supported version of Nginx/ OpenResty and use the 'GA' tagged release from the [APIcast repository](https://github.com/3scale/apicast/releases).\r\n+  - <a href=\"https://support.3scale.net/guides/infrastructure/docker-openshift\">OpenShift</a>: Where the customer deploys on a supported version of OpenShift a released and unmodified OpenShift template for APIcast, which will run the official Docker images.\r\n+  - Docker: Where the customer runs a dockerized image downloaded from the Red Hat Docker Registry, using a supported version of Docker.\r\n+\r\n+## Environments\r\n+\r\n+By default, when you create a 3scale account, you get APIcast **hosted** in two different environments:\r\n+\r\n+- **Staging**: It’s meant to be used only while configuring and testing your API integration. When you have confirmed that your setup is working as expected, then you can choose to deploy it to the production environment.\r\n+- **Production**: Limited 50,000 calls per day and supports the following out-of-the-box authentication options: App key, app key and app id pair.\r\n+\r\n+## Getting API traffic in 1 minute\r\n+\r\n+Follow the next steps to configure your API gateway in no time:\r\n+\r\n+### 1. Declare your private base URL\r\n+\r\n+The **private base URL** is the endpoint host of your API backend. For instance, if you were Twitter the Private Base URL would be ```https://api.twitter.com/```, or if you are the owner of the Sentiment API it would be ```http://api-sentiment.3scale.net/```.\r\n+\r\n+The gateway will redirect all traffic to your API backend after all authentication, authorization, rate limits and statistics have been processed.\r\n+\r\n+### Step 2: Update the hosted gateway\r\n+\r\n+To update the **hosted gateway** you just have to **save** the settings (API backend, Advanced settings etc.) by clicking on the **Update & Test Staging Configuration** button in the lower right part of the page. This process will deploy your gateway configuration (at this stage the default configuration) to 3scale's hosted gateway.\r\n+\r\n+### Step 3: Get a set of sample credentials\r\n+\r\n+Go to the **Applications**, click on any application using the service you're configuring, and get the **API credentials**. If you do not have applications/ users yet, you can create an application yourself (from the details page of any individual developer account), the credentials will be generated automatically.\r","path":"doc/overview.md","position":39,"original_position":39,"commit_id":"947ab6eff4df0077c183ed1d63c1f9c2c60d0dc3","original_commit_id":"947ab6eff4df0077c183ed1d63c1f9c2c60d0dc3","user":{"login":"davidor","id":907223,"avatar_url":"https://avatars.githubusercontent.com/u/907223?v=3","gravatar_id":"","url":"https://api.github.com/users/davidor","html_url":"https://github.com/davidor","followers_url":"https://api.github.com/users/davidor/followers","following_url":"https://api.github.com/users/davidor/following{/other_user}","gists_url":"https://api.github.com/users/davidor/gists{/gist_id}","starred_url":"https://api.github.com/users/davidor/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davidor/subscriptions","organizations_url":"https://api.github.com/users/davidor/orgs","repos_url":"https://api.github.com/users/davidor/repos","events_url":"https://api.github.com/users/davidor/events{/privacy}","received_events_url":"https://api.github.com/users/davidor/received_events","type":"User","site_admin":false},"body":"Applications tab?","created_at":"2016-12-02T10:11:11Z","updated_at":"2016-12-02T10:11:12Z","html_url":"https://github.com/3scale/apicast/pull/143#discussion_r90616324","pull_request_url":"https://api.github.com/repos/3scale/apicast/pulls/143","_links":{"self":{"href":"https://api.github.com/repos/3scale/apicast/pulls/comments/90616324"},"html":{"href":"https://github.com/3scale/apicast/pull/143#discussion_r90616324"},"pull_request":{"href":"https://api.github.com/repos/3scale/apicast/pulls/143"}}},"pull_request":{"url":"https://api.github.com/repos/3scale/apicast/pulls/143","id":94073673,"html_url":"https://github.com/3scale/apicast/pull/143","diff_url":"https://github.com/3scale/apicast/pull/143.diff","patch_url":"https://github.com/3scale/apicast/pull/143.patch","issue_url":"https://api.github.com/repos/3scale/apicast/issues/143","number":143,"state":"open","locked":false,"title":"Adds overview doc","user":{"login":"vramosp","id":987667,"avatar_url":"https://avatars.githubusercontent.com/u/987667?v=3","gravatar_id":"","url":"https://api.github.com/users/vramosp","html_url":"https://github.com/vramosp","followers_url":"https://api.github.com/users/vramosp/followers","following_url":"https://api.github.com/users/vramosp/following{/other_user}","gists_url":"https://api.github.com/users/vramosp/gists{/gist_id}","starred_url":"https://api.github.com/users/vramosp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vramosp/subscriptions","organizations_url":"https://api.github.com/users/vramosp/orgs","repos_url":"https://api.github.com/users/vramosp/repos","events_url":"https://api.github.com/users/vramosp/events{/privacy}","received_events_url":"https://api.github.com/users/vramosp/received_events","type":"User","site_admin":false},"body":"","created_at":"2016-11-16T23:36:12Z","updated_at":"2016-12-02T10:11:12Z","closed_at":null,"merged_at":null,"merge_commit_sha":"3a4e5209cc7d985d04be52362895d64292753dff","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/3scale/apicast/pulls/143/commits","review_comments_url":"https://api.github.com/repos/3scale/apicast/pulls/143/comments","review_comment_url":"https://api.github.com/repos/3scale/apicast/pulls/comments{/number}","comments_url":"https://api.github.com/repos/3scale/apicast/issues/143/comments","statuses_url":"https://api.github.com/repos/3scale/apicast/statuses/947ab6eff4df0077c183ed1d63c1f9c2c60d0dc3","head":{"label":"3scale:overview","ref":"overview","sha":"947ab6eff4df0077c183ed1d63c1f9c2c60d0dc3","user":{"login":"3scale","id":21415,"avatar_url":"https://avatars.githubusercontent.com/u/21415?v=3","gravatar_id":"","url":"https://api.github.com/users/3scale","html_url":"https://github.com/3scale","followers_url":"https://api.github.com/users/3scale/followers","following_url":"https://api.github.com/users/3scale/following{/other_user}","gists_url":"https://api.github.com/users/3scale/gists{/gist_id}","starred_url":"https://api.github.com/users/3scale/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/3scale/subscriptions","organizations_url":"https://api.github.com/users/3scale/orgs","repos_url":"https://api.github.com/users/3scale/repos","events_url":"https://api.github.com/users/3scale/events{/privacy}","received_events_url":"https://api.github.com/users/3scale/received_events","type":"Organization","site_admin":false},"repo":{"id":53965666,"name":"apicast","full_name":"3scale/apicast","owner":{"login":"3scale","id":21415,"avatar_url":"https://avatars.githubusercontent.com/u/21415?v=3","gravatar_id":"","url":"https://api.github.com/users/3scale","html_url":"https://github.com/3scale","followers_url":"https://api.github.com/users/3scale/followers","following_url":"https://api.github.com/users/3scale/following{/other_user}","gists_url":"https://api.github.com/users/3scale/gists{/gist_id}","starred_url":"https://api.github.com/users/3scale/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/3scale/subscriptions","organizations_url":"https://api.github.com/users/3scale/orgs","repos_url":"https://api.github.com/users/3scale/repos","events_url":"https://api.github.com/users/3scale/events{/privacy}","received_events_url":"https://api.github.com/users/3scale/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/3scale/apicast","description":"3scale api gateway reloaded","fork":false,"url":"https://api.github.com/repos/3scale/apicast","forks_url":"https://api.github.com/repos/3scale/apicast/forks","keys_url":"https://api.github.com/repos/3scale/apicast/keys{/key_id}","collaborators_url":"https://api.github.com/repos/3scale/apicast/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/3scale/apicast/teams","hooks_url":"https://api.github.com/repos/3scale/apicast/hooks","issue_events_url":"https://api.github.com/repos/3scale/apicast/issues/events{/number}","events_url":"https://api.github.com/repos/3scale/apicast/events","assignees_url":"https://api.github.com/repos/3scale/apicast/assignees{/user}","branches_url":"https://api.github.com/repos/3scale/apicast/branches{/branch}","tags_url":"https://api.github.com/repos/3scale/apicast/tags","blobs_url":"https://api.github.com/repos/3scale/apicast/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/3scale/apicast/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/3scale/apicast/git/refs{/sha}","trees_url":"https://api.github.com/repos/3scale/apicast/git/trees{/sha}","statuses_url":"https://api.github.com/repos/3scale/apicast/statuses/{sha}","languages_url":"https://api.github.com/repos/3scale/apicast/languages","stargazers_url":"https://api.github.com/repos/3scale/apicast/stargazers","contributors_url":"https://api.github.com/repos/3scale/apicast/contributors","subscribers_url":"https://api.github.com/repos/3scale/apicast/subscribers","subscription_url":"https://api.github.com/repos/3scale/apicast/subscription","commits_url":"https://api.github.com/repos/3scale/apicast/commits{/sha}","git_commits_url":"https://api.github.com/repos/3scale/apicast/git/commits{/sha}","comments_url":"https://api.github.com/repos/3scale/apicast/comments{/number}","issue_comment_url":"https://api.github.com/repos/3scale/apicast/issues/comments{/number}","contents_url":"https://api.github.com/repos/3scale/apicast/contents/{+path}","compare_url":"https://api.github.com/repos/3scale/apicast/compare/{base}...{head}","merges_url":"https://api.github.com/repos/3scale/apicast/merges","archive_url":"https://api.github.com/repos/3scale/apicast/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/3scale/apicast/downloads","issues_url":"https://api.github.com/repos/3scale/apicast/issues{/number}","pulls_url":"https://api.github.com/repos/3scale/apicast/pulls{/number}","milestones_url":"https://api.github.com/repos/3scale/apicast/milestones{/number}","notifications_url":"https://api.github.com/repos/3scale/apicast/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/3scale/apicast/labels{/name}","releases_url":"https://api.github.com/repos/3scale/apicast/releases{/id}","deployments_url":"https://api.github.com/repos/3scale/apicast/deployments","created_at":"2016-03-15T17:41:51Z","updated_at":"2016-11-16T15:52:34Z","pushed_at":"2016-11-30T14:24:36Z","git_url":"git://github.com/3scale/apicast.git","ssh_url":"git@github.com:3scale/apicast.git","clone_url":"https://github.com/3scale/apicast.git","svn_url":"https://github.com/3scale/apicast","homepage":"","size":559,"stargazers_count":8,"watchers_count":8,"language":"Lua","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":23,"forks":8,"open_issues":23,"watchers":8,"default_branch":"v2"}},"base":{"label":"3scale:v2","ref":"v2","sha":"aa90a583e65db3299644d62d610564e9ffd74844","user":{"login":"3scale","id":21415,"avatar_url":"https://avatars.githubusercontent.com/u/21415?v=3","gravatar_id":"","url":"https://api.github.com/users/3scale","html_url":"https://github.com/3scale","followers_url":"https://api.github.com/users/3scale/followers","following_url":"https://api.github.com/users/3scale/following{/other_user}","gists_url":"https://api.github.com/users/3scale/gists{/gist_id}","starred_url":"https://api.github.com/users/3scale/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/3scale/subscriptions","organizations_url":"https://api.github.com/users/3scale/orgs","repos_url":"https://api.github.com/users/3scale/repos","events_url":"https://api.github.com/users/3scale/events{/privacy}","received_events_url":"https://api.github.com/users/3scale/received_events","type":"Organization","site_admin":false},"repo":{"id":53965666,"name":"apicast","full_name":"3scale/apicast","owner":{"login":"3scale","id":21415,"avatar_url":"https://avatars.githubusercontent.com/u/21415?v=3","gravatar_id":"","url":"https://api.github.com/users/3scale","html_url":"https://github.com/3scale","followers_url":"https://api.github.com/users/3scale/followers","following_url":"https://api.github.com/users/3scale/following{/other_user}","gists_url":"https://api.github.com/users/3scale/gists{/gist_id}","starred_url":"https://api.github.com/users/3scale/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/3scale/subscriptions","organizations_url":"https://api.github.com/users/3scale/orgs","repos_url":"https://api.github.com/users/3scale/repos","events_url":"https://api.github.com/users/3scale/events{/privacy}","received_events_url":"https://api.github.com/users/3scale/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/3scale/apicast","description":"3scale api gateway reloaded","fork":false,"url":"https://api.github.com/repos/3scale/apicast","forks_url":"https://api.github.com/repos/3scale/apicast/forks","keys_url":"https://api.github.com/repos/3scale/apicast/keys{/key_id}","collaborators_url":"https://api.github.com/repos/3scale/apicast/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/3scale/apicast/teams","hooks_url":"https://api.github.com/repos/3scale/apicast/hooks","issue_events_url":"https://api.github.com/repos/3scale/apicast/issues/events{/number}","events_url":"https://api.github.com/repos/3scale/apicast/events","assignees_url":"https://api.github.com/repos/3scale/apicast/assignees{/user}","branches_url":"https://api.github.com/repos/3scale/apicast/branches{/branch}","tags_url":"https://api.github.com/repos/3scale/apicast/tags","blobs_url":"https://api.github.com/repos/3scale/apicast/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/3scale/apicast/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/3scale/apicast/git/refs{/sha}","trees_url":"https://api.github.com/repos/3scale/apicast/git/trees{/sha}","statuses_url":"https://api.github.com/repos/3scale/apicast/statuses/{sha}","languages_url":"https://api.github.com/repos/3scale/apicast/languages","stargazers_url":"https://api.github.com/repos/3scale/apicast/stargazers","contributors_url":"https://api.github.com/repos/3scale/apicast/contributors","subscribers_url":"https://api.github.com/repos/3scale/apicast/subscribers","subscription_url":"https://api.github.com/repos/3scale/apicast/subscription","commits_url":"https://api.github.com/repos/3scale/apicast/commits{/sha}","git_commits_url":"https://api.github.com/repos/3scale/apicast/git/commits{/sha}","comments_url":"https://api.github.com/repos/3scale/apicast/comments{/number}","issue_comment_url":"https://api.github.com/repos/3scale/apicast/issues/comments{/number}","contents_url":"https://api.github.com/repos/3scale/apicast/contents/{+path}","compare_url":"https://api.github.com/repos/3scale/apicast/compare/{base}...{head}","merges_url":"https://api.github.com/repos/3scale/apicast/merges","archive_url":"https://api.github.com/repos/3scale/apicast/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/3scale/apicast/downloads","issues_url":"https://api.github.com/repos/3scale/apicast/issues{/number}","pulls_url":"https://api.github.com/repos/3scale/apicast/pulls{/number}","milestones_url":"https://api.github.com/repos/3scale/apicast/milestones{/number}","notifications_url":"https://api.github.com/repos/3scale/apicast/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/3scale/apicast/labels{/name}","releases_url":"https://api.github.com/repos/3scale/apicast/releases{/id}","deployments_url":"https://api.github.com/repos/3scale/apicast/deployments","created_at":"2016-03-15T17:41:51Z","updated_at":"2016-11-16T15:52:34Z","pushed_at":"2016-11-30T14:24:36Z","git_url":"git://github.com/3scale/apicast.git","ssh_url":"git@github.com:3scale/apicast.git","clone_url":"https://github.com/3scale/apicast.git","svn_url":"https://github.com/3scale/apicast","homepage":"","size":559,"stargazers_count":8,"watchers_count":8,"language":"Lua","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":23,"forks":8,"open_issues":23,"watchers":8,"default_branch":"v2"}},"_links":{"self":{"href":"https://api.github.com/repos/3scale/apicast/pulls/143"},"html":{"href":"https://github.com/3scale/apicast/pull/143"},"issue":{"href":"https://api.github.com/repos/3scale/apicast/issues/143"},"comments":{"href":"https://api.github.com/repos/3scale/apicast/issues/143/comments"},"review_comments":{"href":"https://api.github.com/repos/3scale/apicast/pulls/143/comments"},"review_comment":{"href":"https://api.github.com/repos/3scale/apicast/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/3scale/apicast/pulls/143/commits"},"statuses":{"href":"https://api.github.com/repos/3scale/apicast/statuses/947ab6eff4df0077c183ed1d63c1f9c2c60d0dc3"}}}}
{"actor":{"display_login":"davidor"}}