{"action":"created","comment":{"url":"https://api.github.com/repos/ravendb/docs/pulls/comments/204652257","pull_request_review_id":139757377,"id":204652257,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIwNDY1MjI1Nw==","diff_hunk":"@@ -0,0 +1,75 @@\n+﻿# RavenDB Embedded\n+\n+## Overview\n+\n+RavenDB makes it very easy to be embedded within your application, with RavenDB Embedded package you \n+don't need to do anything only download the package and start your own RavenDB Embedded server.\n+{CODE-TABS}\n+{CODE-TAB:csharp:Sync embedded_example@Server\\Embedded.cs /}\n+{CODE-TAB:csharp:Async embedded_async_example@Server\\Embedded.cs /}\n+{CODE-TABS/}\n+\n+## Getting Started\n+---\n+* Create a new project (.NET Core, .Net Framework, whatever).\n+* Grab the [pre-release bits from MyGet](https://myget.org/feed/ravendb/package/nuget/RavenDB.embedded).\n+Install-Package RavenDB.Embedded -Version 4.1.0 -Source https://www.myget.org/F/ravendb/api/v3/index.json\n+* Start a new Embedded Server\n+* Ask the embedded client for a document store, and start working with documents.\n+\n+### Start The Server\n+To start a RavenDB Embedded server you only need to get the Instance of the Embedded Server and then call `StartServer` method.\n+{CODE start_server@Server\\Embedded.cs /}\n+\n+For more control on how to start the server just pass to `StartServer` method a [`ServerOptions`](../../csharp/glossary/server-options) object and that`s it.\n+{CODE start_server_with_options@Server\\Embedded.cs /}\n+\n+{NOTE  Without the `ServerOptions`, RavenDB server will start with a default values on 127.0.0.1:{Random Port}  /}\n+\n+##### Security\n+RavenDB Embedded support running a secured server.\n+Just run `Secured` method in [`ServerOption`](../../csharp/glossary/server-options) object.\n+We have two overloads to `Secured`:\n+{CODE security@Server\\Embedded.cs /}\n+\n+The first way to enable authentication is to set certificate with the path to your .pfx \n+server certificate. You may supply the certificate password using certPassword.\n+\n+{CODE security2@Server\\Embedded.cs /}\n+\n+This option is useful when you want to protect your certificate (private key) with other solutions such as \"Azure Key Vault\", \"HashiCorp Vault\" or even Hardware-Based Protection. RavenDB will invoke a process you specify, so you can write your own scripts / mini programs and apply whatever logic you need. It creates a clean separation between RavenDB and the secret store in use.\n+RavenDB expects to get the raw binary representation (byte array) of the .pfx certificate through the standard output.\n+In this options you can control on your client certificate and to use in a different certificate for your client.\n+\n+### Get Document Store\n+After Starting the server you can get the DocumentStore from the Embedded Server and start working with RavenDB.\n+Getting the DocumentStore from The Embedded Server is pretty easy you only need to call `GetDocumentStore` or `GetDocumentStoreAsync` with the name of the database you like to work with. \n+\n+{CODE-TABS}\n+{CODE-TAB:csharp:Sync get_document_store@Server\\Embedded.cs /}\n+{CODE-TAB:csharp:Async get_async_document_store@Server\\Embedded.cs /}\n+{CODE-TABS/}\n+\n+For more control on the process you can call the methods with [`DatabaseOptions`](../../csharp/glossary/database-options) object.\n+\n+{CODE-TABS}\n+{CODE-TAB:csharp:Sync get_document_store_with_database_options@Server\\Embedded.cs /}\n+{CODE-TAB:csharp:Async get_async_document_store_with_database_options@Server\\Embedded.cs /}}\n+{CODE-TABS/}\n+\n+### Get Server Url\n+For getting the server url you only need to call `GetServerUriAsync` method, this async method will return `Uri` object.\n+If `StartServer` is not yet complete this method will wait for the server to start.\n+\n+{CODE get_server_url_async@Server/Embedded.cs /}\n+\n+## Acknowledgments\n+* You can have only one instance of `EmbeddedServer`.\n+* {NOTE: Open RavenDB studio in the browser}\n+You can open the studio in the browser with `OpenStudioInBrowser` method\n+  {CODE open_in_browser@Server/Embedded.cs /}\n+{NOTE /}\n+* If you don't have dotnet install you can download it from [here](https://www.microsoft.com/net/download/dotnet-core/runtime-2.1.1) ","path":"Documentation/4.1/Raven.Documentation.Pages/server/Embedded.dotnet.markdown","position":72,"original_position":72,"commit_id":"d7e3abe48e7e7004135a48d4568951ef03f84c37","original_commit_id":"d7e3abe48e7e7004135a48d4568951ef03f84c37","user":{"login":"ppekrol","id":446555,"node_id":"MDQ6VXNlcjQ0NjU1NQ==","avatar_url":"https://avatars2.githubusercontent.com/u/446555?v=4","gravatar_id":"","url":"https://api.github.com/users/ppekrol","html_url":"https://github.com/ppekrol","followers_url":"https://api.github.com/users/ppekrol/followers","following_url":"https://api.github.com/users/ppekrol/following{/other_user}","gists_url":"https://api.github.com/users/ppekrol/gists{/gist_id}","starred_url":"https://api.github.com/users/ppekrol/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ppekrol/subscriptions","organizations_url":"https://api.github.com/users/ppekrol/orgs","repos_url":"https://api.github.com/users/ppekrol/repos","events_url":"https://api.github.com/users/ppekrol/events{/privacy}","received_events_url":"https://api.github.com/users/ppekrol/received_events","type":"User","site_admin":false},"body":"Link to https://www.microsoft.com/net/download\r\n\r\nWe need to extend this description. .NET Core SDKs are required along with the runtime. Write that runtime is set in ServerOptions to the one that we compiled the server with, but can be changed.","created_at":"2018-07-24T07:37:22Z","updated_at":"2018-07-24T07:40:25Z","html_url":"https://github.com/ravendb/docs/pull/753#discussion_r204652257","pull_request_url":"https://api.github.com/repos/ravendb/docs/pulls/753","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/ravendb/docs/pulls/comments/204652257"},"html":{"href":"https://github.com/ravendb/docs/pull/753#discussion_r204652257"},"pull_request":{"href":"https://api.github.com/repos/ravendb/docs/pulls/753"}}},"pull_request":{"url":"https://api.github.com/repos/ravendb/docs/pulls/753","id":203250041,"node_id":"MDExOlB1bGxSZXF1ZXN0MjAzMjUwMDQx","html_url":"https://github.com/ravendb/docs/pull/753","diff_url":"https://github.com/ravendb/docs/pull/753.diff","patch_url":"https://github.com/ravendb/docs/pull/753.patch","issue_url":"https://api.github.com/repos/ravendb/docs/issues/753","number":753,"state":"open","locked":false,"title":"Add v4.1 docs","user":{"login":"IdanHaim","id":10860984,"node_id":"MDQ6VXNlcjEwODYwOTg0","avatar_url":"https://avatars3.githubusercontent.com/u/10860984?v=4","gravatar_id":"","url":"https://api.github.com/users/IdanHaim","html_url":"https://github.com/IdanHaim","followers_url":"https://api.github.com/users/IdanHaim/followers","following_url":"https://api.github.com/users/IdanHaim/following{/other_user}","gists_url":"https://api.github.com/users/IdanHaim/gists{/gist_id}","starred_url":"https://api.github.com/users/IdanHaim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IdanHaim/subscriptions","organizations_url":"https://api.github.com/users/IdanHaim/orgs","repos_url":"https://api.github.com/users/IdanHaim/repos","events_url":"https://api.github.com/users/IdanHaim/events{/privacy}","received_events_url":"https://api.github.com/users/IdanHaim/received_events","type":"User","site_admin":false},"body":"Need to create a new branch maybe","created_at":"2018-07-23T15:06:12Z","updated_at":"2018-07-24T07:40:25Z","closed_at":null,"merged_at":null,"merge_commit_sha":"081b53b1fed74b36ceb69828717a7f73e86cea78","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ravendb/docs/pulls/753/commits","review_comments_url":"https://api.github.com/repos/ravendb/docs/pulls/753/comments","review_comment_url":"https://api.github.com/repos/ravendb/docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ravendb/docs/issues/753/comments","statuses_url":"https://api.github.com/repos/ravendb/docs/statuses/d7e3abe48e7e7004135a48d4568951ef03f84c37","head":{"label":"IdanHaim:RDoc-1252","ref":"RDoc-1252","sha":"d7e3abe48e7e7004135a48d4568951ef03f84c37","user":{"login":"IdanHaim","id":10860984,"node_id":"MDQ6VXNlcjEwODYwOTg0","avatar_url":"https://avatars3.githubusercontent.com/u/10860984?v=4","gravatar_id":"","url":"https://api.github.com/users/IdanHaim","html_url":"https://github.com/IdanHaim","followers_url":"https://api.github.com/users/IdanHaim/followers","following_url":"https://api.github.com/users/IdanHaim/following{/other_user}","gists_url":"https://api.github.com/users/IdanHaim/gists{/gist_id}","starred_url":"https://api.github.com/users/IdanHaim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IdanHaim/subscriptions","organizations_url":"https://api.github.com/users/IdanHaim/orgs","repos_url":"https://api.github.com/users/IdanHaim/repos","events_url":"https://api.github.com/users/IdanHaim/events{/privacy}","received_events_url":"https://api.github.com/users/IdanHaim/received_events","type":"User","site_admin":false},"repo":{"id":65298293,"node_id":"MDEwOlJlcG9zaXRvcnk2NTI5ODI5Mw==","name":"docs","full_name":"IdanHaim/docs","owner":{"login":"IdanHaim","id":10860984,"node_id":"MDQ6VXNlcjEwODYwOTg0","avatar_url":"https://avatars3.githubusercontent.com/u/10860984?v=4","gravatar_id":"","url":"https://api.github.com/users/IdanHaim","html_url":"https://github.com/IdanHaim","followers_url":"https://api.github.com/users/IdanHaim/followers","following_url":"https://api.github.com/users/IdanHaim/following{/other_user}","gists_url":"https://api.github.com/users/IdanHaim/gists{/gist_id}","starred_url":"https://api.github.com/users/IdanHaim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IdanHaim/subscriptions","organizations_url":"https://api.github.com/users/IdanHaim/orgs","repos_url":"https://api.github.com/users/IdanHaim/repos","events_url":"https://api.github.com/users/IdanHaim/events{/privacy}","received_events_url":"https://api.github.com/users/IdanHaim/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/IdanHaim/docs","description":"Documenation book for RavenDB","fork":true,"url":"https://api.github.com/repos/IdanHaim/docs","forks_url":"https://api.github.com/repos/IdanHaim/docs/forks","keys_url":"https://api.github.com/repos/IdanHaim/docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/IdanHaim/docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/IdanHaim/docs/teams","hooks_url":"https://api.github.com/repos/IdanHaim/docs/hooks","issue_events_url":"https://api.github.com/repos/IdanHaim/docs/issues/events{/number}","events_url":"https://api.github.com/repos/IdanHaim/docs/events","assignees_url":"https://api.github.com/repos/IdanHaim/docs/assignees{/user}","branches_url":"https://api.github.com/repos/IdanHaim/docs/branches{/branch}","tags_url":"https://api.github.com/repos/IdanHaim/docs/tags","blobs_url":"https://api.github.com/repos/IdanHaim/docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/IdanHaim/docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/IdanHaim/docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/IdanHaim/docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/IdanHaim/docs/statuses/{sha}","languages_url":"https://api.github.com/repos/IdanHaim/docs/languages","stargazers_url":"https://api.github.com/repos/IdanHaim/docs/stargazers","contributors_url":"https://api.github.com/repos/IdanHaim/docs/contributors","subscribers_url":"https://api.github.com/repos/IdanHaim/docs/subscribers","subscription_url":"https://api.github.com/repos/IdanHaim/docs/subscription","commits_url":"https://api.github.com/repos/IdanHaim/docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/IdanHaim/docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/IdanHaim/docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/IdanHaim/docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/IdanHaim/docs/contents/{+path}","compare_url":"https://api.github.com/repos/IdanHaim/docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/IdanHaim/docs/merges","archive_url":"https://api.github.com/repos/IdanHaim/docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/IdanHaim/docs/downloads","issues_url":"https://api.github.com/repos/IdanHaim/docs/issues{/number}","pulls_url":"https://api.github.com/repos/IdanHaim/docs/pulls{/number}","milestones_url":"https://api.github.com/repos/IdanHaim/docs/milestones{/number}","notifications_url":"https://api.github.com/repos/IdanHaim/docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/IdanHaim/docs/labels{/name}","releases_url":"https://api.github.com/repos/IdanHaim/docs/releases{/id}","deployments_url":"https://api.github.com/repos/IdanHaim/docs/deployments","created_at":"2016-08-09T13:43:59Z","updated_at":"2018-07-22T08:15:53Z","pushed_at":"2018-07-23T15:01:28Z","git_url":"git://github.com/IdanHaim/docs.git","ssh_url":"git@github.com:IdanHaim/docs.git","clone_url":"https://github.com/IdanHaim/docs.git","svn_url":"https://github.com/IdanHaim/docs","homepage":"http://ravendb.net","size":84422,"stargazers_count":0,"watchers_count":0,"language":"C#","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"ravendb:master","ref":"master","sha":"830d189d57eb4d17c62b1457134b7459d586da03","user":{"login":"ravendb","id":213792,"node_id":"MDEyOk9yZ2FuaXphdGlvbjIxMzc5Mg==","avatar_url":"https://avatars0.githubusercontent.com/u/213792?v=4","gravatar_id":"","url":"https://api.github.com/users/ravendb","html_url":"https://github.com/ravendb","followers_url":"https://api.github.com/users/ravendb/followers","following_url":"https://api.github.com/users/ravendb/following{/other_user}","gists_url":"https://api.github.com/users/ravendb/gists{/gist_id}","starred_url":"https://api.github.com/users/ravendb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ravendb/subscriptions","organizations_url":"https://api.github.com/users/ravendb/orgs","repos_url":"https://api.github.com/users/ravendb/repos","events_url":"https://api.github.com/users/ravendb/events{/privacy}","received_events_url":"https://api.github.com/users/ravendb/received_events","type":"Organization","site_admin":false},"repo":{"id":961487,"node_id":"MDEwOlJlcG9zaXRvcnk5NjE0ODc=","name":"docs","full_name":"ravendb/docs","owner":{"login":"ravendb","id":213792,"node_id":"MDEyOk9yZ2FuaXphdGlvbjIxMzc5Mg==","avatar_url":"https://avatars0.githubusercontent.com/u/213792?v=4","gravatar_id":"","url":"https://api.github.com/users/ravendb","html_url":"https://github.com/ravendb","followers_url":"https://api.github.com/users/ravendb/followers","following_url":"https://api.github.com/users/ravendb/following{/other_user}","gists_url":"https://api.github.com/users/ravendb/gists{/gist_id}","starred_url":"https://api.github.com/users/ravendb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ravendb/subscriptions","organizations_url":"https://api.github.com/users/ravendb/orgs","repos_url":"https://api.github.com/users/ravendb/repos","events_url":"https://api.github.com/users/ravendb/events{/privacy}","received_events_url":"https://api.github.com/users/ravendb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ravendb/docs","description":"Docs for RavenDB","fork":false,"url":"https://api.github.com/repos/ravendb/docs","forks_url":"https://api.github.com/repos/ravendb/docs/forks","keys_url":"https://api.github.com/repos/ravendb/docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ravendb/docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ravendb/docs/teams","hooks_url":"https://api.github.com/repos/ravendb/docs/hooks","issue_events_url":"https://api.github.com/repos/ravendb/docs/issues/events{/number}","events_url":"https://api.github.com/repos/ravendb/docs/events","assignees_url":"https://api.github.com/repos/ravendb/docs/assignees{/user}","branches_url":"https://api.github.com/repos/ravendb/docs/branches{/branch}","tags_url":"https://api.github.com/repos/ravendb/docs/tags","blobs_url":"https://api.github.com/repos/ravendb/docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ravendb/docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ravendb/docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/ravendb/docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ravendb/docs/statuses/{sha}","languages_url":"https://api.github.com/repos/ravendb/docs/languages","stargazers_url":"https://api.github.com/repos/ravendb/docs/stargazers","contributors_url":"https://api.github.com/repos/ravendb/docs/contributors","subscribers_url":"https://api.github.com/repos/ravendb/docs/subscribers","subscription_url":"https://api.github.com/repos/ravendb/docs/subscription","commits_url":"https://api.github.com/repos/ravendb/docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/ravendb/docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/ravendb/docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/ravendb/docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/ravendb/docs/contents/{+path}","compare_url":"https://api.github.com/repos/ravendb/docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ravendb/docs/merges","archive_url":"https://api.github.com/repos/ravendb/docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ravendb/docs/downloads","issues_url":"https://api.github.com/repos/ravendb/docs/issues{/number}","pulls_url":"https://api.github.com/repos/ravendb/docs/pulls{/number}","milestones_url":"https://api.github.com/repos/ravendb/docs/milestones{/number}","notifications_url":"https://api.github.com/repos/ravendb/docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ravendb/docs/labels{/name}","releases_url":"https://api.github.com/repos/ravendb/docs/releases{/id}","deployments_url":"https://api.github.com/repos/ravendb/docs/deployments","created_at":"2010-10-04T19:12:52Z","updated_at":"2018-07-20T12:05:05Z","pushed_at":"2018-07-23T15:06:13Z","git_url":"git://github.com/ravendb/docs.git","ssh_url":"git@github.com:ravendb/docs.git","clone_url":"https://github.com/ravendb/docs.git","svn_url":"https://github.com/ravendb/docs","homepage":"https://ravendb.net","size":84396,"stargazers_count":91,"watchers_count":91,"language":"C#","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":111,"mirror_url":null,"archived":false,"open_issues_count":2,"license":null,"forks":111,"open_issues":2,"watchers":91,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ravendb/docs/pulls/753"},"html":{"href":"https://github.com/ravendb/docs/pull/753"},"issue":{"href":"https://api.github.com/repos/ravendb/docs/issues/753"},"comments":{"href":"https://api.github.com/repos/ravendb/docs/issues/753/comments"},"review_comments":{"href":"https://api.github.com/repos/ravendb/docs/pulls/753/comments"},"review_comment":{"href":"https://api.github.com/repos/ravendb/docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ravendb/docs/pulls/753/commits"},"statuses":{"href":"https://api.github.com/repos/ravendb/docs/statuses/d7e3abe48e7e7004135a48d4568951ef03f84c37"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"ppekrol"}}