{"action":"created","comment":{"url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/comments/186259330","pull_request_review_id":117811257,"id":186259330,"diff_hunk":"@@ -97,96 +103,52 @@ Congratulations! Your FredBoat should be running now. If you haven't invited you\n \n \n \n-# Selfhost FredBoat from scratch\n-_FredBoat is written in Java, so it runs pretty much anywhere where you can install a Java Virtual Machine._\n-\n-\n-## Requirements\n-\n-1. Java 8 **JRE**: [Oracle](https://www.java.com/en/download/) or [OpenJDK](http://openjdk.java.net/install/index.html)\n-\n-2. [A PostgreSQL 10 Database](https://wiki.postgresql.org/wiki/Detailed_installation_guides). See the JDBC url section in the credentials file for more accurate information. FredBoat requires the Hstore extension to be present in the databases it connects to.\n-\n-3. A FredBoat.jar. Either [download it from our CI server](#ci-server) or [build it yourself](#build-the-fredboat-jar-from-source).\n-\n-\n-Got all those things together? [Click here](#config-and-credentials) to learn how to set up config and credentials files, then proceed with the instructions on how to run FredBoat.\n-\n-\n-## Run FredBoat\n-\n-To run FredBoat you should set up a directory that looks like this:\n-\n-![Directory](https://fred.moe/9Eu.png)\n-\n-\n-Once you are done configuring and collecting the necessary credentials, navigate to the directory `FredBoat.jar` is in:\n-```sh\n-cd /path/to/my/Download/folder/containing/FredBoat\n-```\n-and run it with:\n-```sh\n-java -jar -Xmx128m FredBoat.jar\n-```\n-Please note: Double clicking the jar won't work!\n-\n-\n-[Follow this link](/docs/systemdservice) to find a tutorial on running FredBoat as a `systemd` service so that it starts and restarts automatically.\n-\n-\n Congratulations! Your FredBoat should be running now. If you haven't invited your bot to your guild yet, [visit this tutorial](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) to find out how to do it.\n \n \n \n # Config and Credentials\n \n-A sample `config.yaml` and an example `credentials.yaml` can be found on [our CI server](#ci-server).\n+A sample `fredboat.yaml` and an example `quarterdeck.yaml` can be found on [our CI server](#ci-server).\n \n You need to read and edit both files according to your preferences. Occasionally new values are added and old ones replaced or discontinued. Check back regularly for updates of those files.\n \n-In order to run FredBoat, you must populate the `credentials.yaml` file with a bot token for Discord and a Youtube API key. More stuff, for example Spotify, can be enabled by filling out the corresponding credentials under `Optional APIs` in the credentials file.\n-\n-Unless you are using docker-compose, make sure to add the JDBC url of your PostgreSQL database to the credentials file too.\n+In order to run FredBoat, you must populate the `fredboat.yaml` file with a bot token for Discord and a Youtube API key. More stuff, for example Spotify, can be enabled by filling out the corresponding credentials under `Optional APIs` in the `fredboat.yaml` file. Furthermore, it is critical you follow the instructions to setup the backend credentials, matching those from `quarterdeck.yaml` with the cooresponding fields in `fredboat.yaml`, which is the central file for the bot. \n \n+## Binaries \n \n-# Build the FredBoat jar from source\n-_I want the full open source experience_\n+FredBoat aims to still be compilable easily through Gradle, and the generated jar's (`FredBoat.jar`, `QuarterDeck.jar`, etc.) can be built manually.\n \n-## Requirements to build FredBoat from source\n+**This method is not recommended unless you wish to edit the source, or are an advanced user who knows what he/she are doing!**\n \n-1. Java 8 **JDK**: [Oracle](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) or [OpenJDK](http://openjdk.java.net/install/index.html)\n+First, make sure you have the following:\n \n+1. Java 10 **JDK**: [Oracle](http://www.oracle.com/technetwork/java/javase/downloads/jdk10-downloads-4416644.html) or [OpenJDK](http://jdk.java.net/10/)\n+ \n 2. [Git](https://www.atlassian.com/git/tutorials/install-git)\n-\n+ \n 3. [JDK added to your PATH](https://www.tutorialspoint.com/maven/maven_environment_setup.htm)\n \n-\n-## Instructions to build FredBoat from source\n-\n-Open Terminal or Command Prompt and `cd` to the directory where you wish to download the FredBoat repo to.\n-\n-Clone the FredBoat GitHub repository and move into the newly created directory:\n+- Clone the project repo:\n \n ```sh\n+\n git clone https://github.com/Frederikam/FredBoat.git\n cd FredBoat\n-```\n \n-If you want to run stable builds, switch to the stable branch:\n-```sh\n-git checkout stable\n ```\n+- Checkout to the `dev` branch, which is the current working branch:\n \n-You can change back anytime to the development branch like this, just remember to compile again after switching:\n ```sh\n git checkout dev\n+\n ```\n \n+*If you want to do any changes to FredBoat's code, this is the place and time to do them. Remember, after any changes you need to run the build again to compile a fresh jar file containing your changes.*\n \n-If you want to do any changes to FredBoat's code, this is the place and time to do them. Remember, after any changes you need to run the build again to compile a fresh jar file containing your changes.\n \n+- From inside the `FredBoat` folder downloaded from GitHub, you can now compile FredBoat using Gradle 4.7+ (it is always a good idea to ensure you have the proper Gradle version(s)):","path":"public/markdown/selfhosting.md","position":176,"original_position":176,"commit_id":"9d5394157e0c7dc170bdd3c955dd7b5d25974f0d","original_commit_id":"9d5394157e0c7dc170bdd3c955dd7b5d25974f0d","user":{"login":"Frederikam","id":2582617,"avatar_url":"https://avatars0.githubusercontent.com/u/2582617?v=4","gravatar_id":"","url":"https://api.github.com/users/Frederikam","html_url":"https://github.com/Frederikam","followers_url":"https://api.github.com/users/Frederikam/followers","following_url":"https://api.github.com/users/Frederikam/following{/other_user}","gists_url":"https://api.github.com/users/Frederikam/gists{/gist_id}","starred_url":"https://api.github.com/users/Frederikam/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Frederikam/subscriptions","organizations_url":"https://api.github.com/users/Frederikam/orgs","repos_url":"https://api.github.com/users/Frederikam/repos","events_url":"https://api.github.com/users/Frederikam/events{/privacy}","received_events_url":"https://api.github.com/users/Frederikam/received_events","type":"User","site_admin":false},"body":"This version number will become outdated. We include Gradle wrappers for Windows and *NIX. I personally let IDEA use the wrappers, and I don't have gradle globally installed. ","created_at":"2018-05-05T10:58:20Z","updated_at":"2018-05-05T10:58:20Z","html_url":"https://github.com/FredBoat/fredboat.com/pull/28#discussion_r186259330","pull_request_url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/comments/186259330"},"html":{"href":"https://github.com/FredBoat/fredboat.com/pull/28#discussion_r186259330"},"pull_request":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28"}}},"pull_request":{"url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28","id":178243536,"html_url":"https://github.com/FredBoat/fredboat.com/pull/28","diff_url":"https://github.com/FredBoat/fredboat.com/pull/28.diff","patch_url":"https://github.com/FredBoat/fredboat.com/pull/28.patch","issue_url":"https://api.github.com/repos/FredBoat/fredboat.com/issues/28","number":28,"state":"open","locked":false,"title":"Update Docker selfhosting guide ","user":{"login":"shikhir-arora","id":8797918,"avatar_url":"https://avatars2.githubusercontent.com/u/8797918?v=4","gravatar_id":"","url":"https://api.github.com/users/shikhir-arora","html_url":"https://github.com/shikhir-arora","followers_url":"https://api.github.com/users/shikhir-arora/followers","following_url":"https://api.github.com/users/shikhir-arora/following{/other_user}","gists_url":"https://api.github.com/users/shikhir-arora/gists{/gist_id}","starred_url":"https://api.github.com/users/shikhir-arora/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shikhir-arora/subscriptions","organizations_url":"https://api.github.com/users/shikhir-arora/orgs","repos_url":"https://api.github.com/users/shikhir-arora/repos","events_url":"https://api.github.com/users/shikhir-arora/events{/privacy}","received_events_url":"https://api.github.com/users/shikhir-arora/received_events","type":"User","site_admin":false},"body":"**This is ready to merge pending review and any input.** \r\n\r\nJust opening PR to track commits. \r\n\r\n- [x] Update Docker guide with `Dev` only\r\n- [x] More detailed info about config options within the main files \r\n- [x] Brief info about new structure (Quarterdeck, single `fredboat.yaml` file) \r\n- [x] Organization/cleanup\r\n\r\n--\r\n\r\nInput is welome!\r\n","created_at":"2018-03-29T07:07:12Z","updated_at":"2018-05-05T10:58:20Z","closed_at":null,"merged_at":null,"merge_commit_sha":"ecbc1cff6a3ef46b0044c321eabe854541c54d95","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28/commits","review_comments_url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28/comments","review_comment_url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/comments{/number}","comments_url":"https://api.github.com/repos/FredBoat/fredboat.com/issues/28/comments","statuses_url":"https://api.github.com/repos/FredBoat/fredboat.com/statuses/9d5394157e0c7dc170bdd3c955dd7b5d25974f0d","head":{"label":"shikhir-arora:master","ref":"master","sha":"9d5394157e0c7dc170bdd3c955dd7b5d25974f0d","user":{"login":"shikhir-arora","id":8797918,"avatar_url":"https://avatars2.githubusercontent.com/u/8797918?v=4","gravatar_id":"","url":"https://api.github.com/users/shikhir-arora","html_url":"https://github.com/shikhir-arora","followers_url":"https://api.github.com/users/shikhir-arora/followers","following_url":"https://api.github.com/users/shikhir-arora/following{/other_user}","gists_url":"https://api.github.com/users/shikhir-arora/gists{/gist_id}","starred_url":"https://api.github.com/users/shikhir-arora/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shikhir-arora/subscriptions","organizations_url":"https://api.github.com/users/shikhir-arora/orgs","repos_url":"https://api.github.com/users/shikhir-arora/repos","events_url":"https://api.github.com/users/shikhir-arora/events{/privacy}","received_events_url":"https://api.github.com/users/shikhir-arora/received_events","type":"User","site_admin":false},"repo":{"id":124898049,"name":"fredboat.com","full_name":"shikhir-arora/fredboat.com","owner":{"login":"shikhir-arora","id":8797918,"avatar_url":"https://avatars2.githubusercontent.com/u/8797918?v=4","gravatar_id":"","url":"https://api.github.com/users/shikhir-arora","html_url":"https://github.com/shikhir-arora","followers_url":"https://api.github.com/users/shikhir-arora/followers","following_url":"https://api.github.com/users/shikhir-arora/following{/other_user}","gists_url":"https://api.github.com/users/shikhir-arora/gists{/gist_id}","starred_url":"https://api.github.com/users/shikhir-arora/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shikhir-arora/subscriptions","organizations_url":"https://api.github.com/users/shikhir-arora/orgs","repos_url":"https://api.github.com/users/shikhir-arora/repos","events_url":"https://api.github.com/users/shikhir-arora/events{/privacy}","received_events_url":"https://api.github.com/users/shikhir-arora/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/shikhir-arora/fredboat.com","description":null,"fork":true,"url":"https://api.github.com/repos/shikhir-arora/fredboat.com","forks_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/forks","keys_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/keys{/key_id}","collaborators_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/teams","hooks_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/hooks","issue_events_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/issues/events{/number}","events_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/events","assignees_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/assignees{/user}","branches_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/branches{/branch}","tags_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/tags","blobs_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/git/refs{/sha}","trees_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/git/trees{/sha}","statuses_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/statuses/{sha}","languages_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/languages","stargazers_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/stargazers","contributors_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/contributors","subscribers_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/subscribers","subscription_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/subscription","commits_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/commits{/sha}","git_commits_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/git/commits{/sha}","comments_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/comments{/number}","issue_comment_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/issues/comments{/number}","contents_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/contents/{+path}","compare_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/compare/{base}...{head}","merges_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/merges","archive_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/downloads","issues_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/issues{/number}","pulls_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/pulls{/number}","milestones_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/milestones{/number}","notifications_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/labels{/name}","releases_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/releases{/id}","deployments_url":"https://api.github.com/repos/shikhir-arora/fredboat.com/deployments","created_at":"2018-03-12T14:02:26Z","updated_at":"2018-05-05T01:07:06Z","pushed_at":"2018-05-05T01:07:04Z","git_url":"git://github.com/shikhir-arora/fredboat.com.git","ssh_url":"git@github.com:shikhir-arora/fredboat.com.git","clone_url":"https://github.com/shikhir-arora/fredboat.com.git","svn_url":"https://github.com/shikhir-arora/fredboat.com","homepage":"https://fredboat.com","size":640,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"FredBoat:master","ref":"master","sha":"2a9f3a1cab851cecde38dcfc8e9c2ee0cd47b05a","user":{"login":"FredBoat","id":27592062,"avatar_url":"https://avatars3.githubusercontent.com/u/27592062?v=4","gravatar_id":"","url":"https://api.github.com/users/FredBoat","html_url":"https://github.com/FredBoat","followers_url":"https://api.github.com/users/FredBoat/followers","following_url":"https://api.github.com/users/FredBoat/following{/other_user}","gists_url":"https://api.github.com/users/FredBoat/gists{/gist_id}","starred_url":"https://api.github.com/users/FredBoat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/FredBoat/subscriptions","organizations_url":"https://api.github.com/users/FredBoat/orgs","repos_url":"https://api.github.com/users/FredBoat/repos","events_url":"https://api.github.com/users/FredBoat/events{/privacy}","received_events_url":"https://api.github.com/users/FredBoat/received_events","type":"Organization","site_admin":false},"repo":{"id":95776745,"name":"fredboat.com","full_name":"FredBoat/fredboat.com","owner":{"login":"FredBoat","id":27592062,"avatar_url":"https://avatars3.githubusercontent.com/u/27592062?v=4","gravatar_id":"","url":"https://api.github.com/users/FredBoat","html_url":"https://github.com/FredBoat","followers_url":"https://api.github.com/users/FredBoat/followers","following_url":"https://api.github.com/users/FredBoat/following{/other_user}","gists_url":"https://api.github.com/users/FredBoat/gists{/gist_id}","starred_url":"https://api.github.com/users/FredBoat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/FredBoat/subscriptions","organizations_url":"https://api.github.com/users/FredBoat/orgs","repos_url":"https://api.github.com/users/FredBoat/repos","events_url":"https://api.github.com/users/FredBoat/events{/privacy}","received_events_url":"https://api.github.com/users/FredBoat/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/FredBoat/fredboat.com","description":null,"fork":false,"url":"https://api.github.com/repos/FredBoat/fredboat.com","forks_url":"https://api.github.com/repos/FredBoat/fredboat.com/forks","keys_url":"https://api.github.com/repos/FredBoat/fredboat.com/keys{/key_id}","collaborators_url":"https://api.github.com/repos/FredBoat/fredboat.com/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/FredBoat/fredboat.com/teams","hooks_url":"https://api.github.com/repos/FredBoat/fredboat.com/hooks","issue_events_url":"https://api.github.com/repos/FredBoat/fredboat.com/issues/events{/number}","events_url":"https://api.github.com/repos/FredBoat/fredboat.com/events","assignees_url":"https://api.github.com/repos/FredBoat/fredboat.com/assignees{/user}","branches_url":"https://api.github.com/repos/FredBoat/fredboat.com/branches{/branch}","tags_url":"https://api.github.com/repos/FredBoat/fredboat.com/tags","blobs_url":"https://api.github.com/repos/FredBoat/fredboat.com/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/FredBoat/fredboat.com/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/FredBoat/fredboat.com/git/refs{/sha}","trees_url":"https://api.github.com/repos/FredBoat/fredboat.com/git/trees{/sha}","statuses_url":"https://api.github.com/repos/FredBoat/fredboat.com/statuses/{sha}","languages_url":"https://api.github.com/repos/FredBoat/fredboat.com/languages","stargazers_url":"https://api.github.com/repos/FredBoat/fredboat.com/stargazers","contributors_url":"https://api.github.com/repos/FredBoat/fredboat.com/contributors","subscribers_url":"https://api.github.com/repos/FredBoat/fredboat.com/subscribers","subscription_url":"https://api.github.com/repos/FredBoat/fredboat.com/subscription","commits_url":"https://api.github.com/repos/FredBoat/fredboat.com/commits{/sha}","git_commits_url":"https://api.github.com/repos/FredBoat/fredboat.com/git/commits{/sha}","comments_url":"https://api.github.com/repos/FredBoat/fredboat.com/comments{/number}","issue_comment_url":"https://api.github.com/repos/FredBoat/fredboat.com/issues/comments{/number}","contents_url":"https://api.github.com/repos/FredBoat/fredboat.com/contents/{+path}","compare_url":"https://api.github.com/repos/FredBoat/fredboat.com/compare/{base}...{head}","merges_url":"https://api.github.com/repos/FredBoat/fredboat.com/merges","archive_url":"https://api.github.com/repos/FredBoat/fredboat.com/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/FredBoat/fredboat.com/downloads","issues_url":"https://api.github.com/repos/FredBoat/fredboat.com/issues{/number}","pulls_url":"https://api.github.com/repos/FredBoat/fredboat.com/pulls{/number}","milestones_url":"https://api.github.com/repos/FredBoat/fredboat.com/milestones{/number}","notifications_url":"https://api.github.com/repos/FredBoat/fredboat.com/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/FredBoat/fredboat.com/labels{/name}","releases_url":"https://api.github.com/repos/FredBoat/fredboat.com/releases{/id}","deployments_url":"https://api.github.com/repos/FredBoat/fredboat.com/deployments","created_at":"2017-06-29T12:46:44Z","updated_at":"2018-04-24T11:15:08Z","pushed_at":"2018-05-05T01:07:06Z","git_url":"git://github.com/FredBoat/fredboat.com.git","ssh_url":"git@github.com:FredBoat/fredboat.com.git","clone_url":"https://github.com/FredBoat/fredboat.com.git","svn_url":"https://github.com/FredBoat/fredboat.com","homepage":"https://fredboat.com","size":605,"stargazers_count":3,"watchers_count":3,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":8,"mirror_url":null,"archived":false,"open_issues_count":2,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":8,"open_issues":2,"watchers":3,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28"},"html":{"href":"https://github.com/FredBoat/fredboat.com/pull/28"},"issue":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/issues/28"},"comments":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/issues/28/comments"},"review_comments":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28/comments"},"review_comment":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/pulls/28/commits"},"statuses":{"href":"https://api.github.com/repos/FredBoat/fredboat.com/statuses/9d5394157e0c7dc170bdd3c955dd7b5d25974f0d"}},"author_association":"NONE"}}
{"actor":{"display_login":"Frederikam"}}