{"action":"created","comment":{"url":"https://api.github.com/repos/gotify/server/pulls/comments/170420486","pull_request_review_id":99111589,"id":170420486,"diff_hunk":"@@ -1,2 +1,139 @@\n # Gotify Server\n-[![Build Status](https://travis-ci.org/gotify/server.svg?branch=master)](https://travis-ci.org/gotify/server) [![codecov](https://codecov.io/gh/gotify/server/branch/master/graph/badge.svg)](https://codecov.io/gh/gotify/server) [![Go Report Card](https://goreportcard.com/badge/github.com/gotify/server)](https://goreportcard.com/report/github.com/gotify/server)\n\\ No newline at end of file\n+[![Build Status][badge-travis]][travis] [![codecov][badge-codecov]][codecov] [![Go Report Card][badge-go-report]][go-report] [![Swagger Valid][badge-swagger]][swagger] [![Api Docs][badge-api-docs]][api-docs] [![latest release version][badge-release]][release]\n+\n+   * [Motivation](#motivation)\n+   * [Features](#features)\n+   * [Installation](#installation)\n+     * [Docker](#docker)\n+     * [Binary](#binary)\n+   * [Configuration](#configuration)\n+      * [File](#file)\n+      * [Environment](#environment)\n+      * [Database](#database)\n+   * [Building](#building)\n+      * [Cross-Platform](#cross-platform)\n+   * [Tests](#tests)\n+   * [Versioning](#versioning)\n+   * [License](#license)\n+\n+## Motivation\n+We wanted a simple server for sending and receiving messages (in real time per websocket). For this, not many open source projects existed and most of the existing ones were abandoned. Also, a requirement was, that it can be self-hostet, we know there are many free and commercial push services out there.\n+\n+## Features\n+* API (see [Swagger Documentation](https://gotify.github.io/api-docs/)) for\n+  * sending messages\n+  * receiving messages per websocket\n+  * user management\n+  * client/device & application management\n+* *[In Progress]* Web-UI\n+* *[In Progress]* Android-App -> [gotify/android](https://github.com/gotify/android)\n+\n+## Installation\n+\n+### Docker\n+The docker image is available on docker hub at [gotify/server](https://hub.docker.com/r/gotify/server/).\n+\n+``` bash\n+docker run -p 80:80 gotify/server\n+```\n+Also there is a specific docker image for arm-7 processors (raspberry pi), named [gotify/server-arm7](https://hub.docker.com/r/gotify/server-arm7/).\n+``` bash\n+docker run -p 80:80 gotify/server-arm7\n+```\n+\n+### Binary\n+Visit the [releases page](https://github.com/gotify/server/releases) and download the zip for your OS.\n+\n+## Configuration\n+### File\n+``` yml\n+server:\n+  port: 80 # the port for the http server\n+  ssl:\n+    enabled: false # if https should be enabled\n+    redirecttohttps: true # redirect to https if site is accessed by http\n+    port: 443 # the https port\n+    certfile: # the cert file (leave empty when using letsencrypt)\n+    certkey: # the cert key (leave empty when using letsencrypt)\n+    letsencrypt:\n+      enabled: false # if the certificate should be requested from letsencrypt\n+      accepttos: false # if you accept the tos from letsencrypt\n+      cache: certs # the directory of the cache from letsencrypt\n+      hosts: # the hosts for which letsencrypt should request certificates\n+      - mydomain.tld\n+      - myotherdomain.tld\n+database: # for database see (configure database section)\n+  dialect: sqlite3\n+  connection: gotify.db\n+defaultuser: # on database creation, gotify creates an admin user\n+  name: admin # the username of the default user\n+  pass: admin # the password of the default user\n+passstrength: 10 # the bcrypt password strength (higher = better but also slower)\n+```\n+\n+### Environment\n+``` bash\n+GOTIFY_SERVER_PORT=80\n+GOTIFY_SERVER_SSL_ENABLED=false\n+GOTIFY_SERVER_SSL_REDIRECTTOHTTPS=true\n+GOTIFY_SERVER_SSL_PORT=443\n+GOTIFY_SERVER_SSL_CERTFILE=\n+GOTIFY_SERVER_SSL_CERTKEY=\n+GOTIFY_SERVER_SSL_LETSENCRYPT_ENABLED=false\n+GOTIFY_SERVER_SSL_LETSENCRYPT_ACCEPTTOS=false\n+GOTIFY_SERVER_SSL_LETSENCRYPT_CACHE=certs\n+# lists are a little weird but do-able (:\n+GOTIFY_SERVER_SSL_LETSENCRYPT_HOSTS=- mydomain.tld\\n- myotherdomain.tld\n+GOTIFY_DATABASE_DIALECT=sqlite3\n+GOTIFY_DATABASE_CONNECTION=gotify.db\n+GOTIFY_DEFAULTUSER_NAME=admin\n+GOTIFY_DEFAULTUSER_PASS=admin\n+GOTIFY_PASSSTRENGTH=10\n+```\n+\n+### Database\n+| Dialect   | Connection                                                           |\n+| :-------: | :------------------------------------------------------------------: |\n+| sqlite3   | `path/to/database.db`                                                |\n+| mysql     | `gotify:secret@/gotifydb?charset=utf8&parseTime=True&loc=Local `     |\n+| postgres  | `host=localhost port=3306 user=gotify dbname=gotify password=secret` |\n+\n+## Building\n+\n+The app can be built with the default golang build command.\n+``` bash\n+go build app.go\n+```\n+\n+### Cross-Platform\n+The project has a CGO reference (because of sqlite3), therefore a GCO cross compiler is needed for compiling for other platforms. We use [karalabe/xgo](https://github.com/karalabe/xgo) for this, xgo is a bundle of docker containers for building go apps.\n+``` bash\n+VERSION=mybuild1 make build-binary\n+```\n+\n+## Tests\n+The tests can be executed with:\n+``` bash\n+make test\n+# or\n+go test ./...\n+```\n+\n+## Versioning\n+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/gotify/server/tags).\n+\n+## License\n+This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details","path":"README.md","position":128,"original_position":128,"commit_id":"0ddb9ee84318d4c6a8f509accb7c3ca5b7c29c41","original_commit_id":"0ddb9ee84318d4c6a8f509accb7c3ca5b7c29c41","user":{"login":"nicories","id":13113768,"avatar_url":"https://avatars2.githubusercontent.com/u/13113768?v=4","gravatar_id":"","url":"https://api.github.com/users/nicories","html_url":"https://github.com/nicories","followers_url":"https://api.github.com/users/nicories/followers","following_url":"https://api.github.com/users/nicories/following{/other_user}","gists_url":"https://api.github.com/users/nicories/gists{/gist_id}","starred_url":"https://api.github.com/users/nicories/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nicories/subscriptions","organizations_url":"https://api.github.com/users/nicories/orgs","repos_url":"https://api.github.com/users/nicories/repos","events_url":"https://api.github.com/users/nicories/events{/privacy}","received_events_url":"https://api.github.com/users/nicories/received_events","type":"User","site_admin":false},"body":"Der Link geht ins Leere","created_at":"2018-02-24T12:47:20Z","updated_at":"2018-02-24T12:49:14Z","html_url":"https://github.com/gotify/server/pull/16#discussion_r170420486","pull_request_url":"https://api.github.com/repos/gotify/server/pulls/16","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/gotify/server/pulls/comments/170420486"},"html":{"href":"https://github.com/gotify/server/pull/16#discussion_r170420486"},"pull_request":{"href":"https://api.github.com/repos/gotify/server/pulls/16"}}},"pull_request":{"url":"https://api.github.com/repos/gotify/server/pulls/16","id":171176371,"html_url":"https://github.com/gotify/server/pull/16","diff_url":"https://github.com/gotify/server/pull/16.diff","patch_url":"https://github.com/gotify/server/pull/16.patch","issue_url":"https://api.github.com/repos/gotify/server/issues/16","number":16,"state":"open","locked":false,"title":"Makefile & Readme","user":{"login":"jmattheis","id":14895212,"avatar_url":"https://avatars2.githubusercontent.com/u/14895212?v=4","gravatar_id":"","url":"https://api.github.com/users/jmattheis","html_url":"https://github.com/jmattheis","followers_url":"https://api.github.com/users/jmattheis/followers","following_url":"https://api.github.com/users/jmattheis/following{/other_user}","gists_url":"https://api.github.com/users/jmattheis/gists{/gist_id}","starred_url":"https://api.github.com/users/jmattheis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jmattheis/subscriptions","organizations_url":"https://api.github.com/users/jmattheis/orgs","repos_url":"https://api.github.com/users/jmattheis/repos","events_url":"https://api.github.com/users/jmattheis/events{/privacy}","received_events_url":"https://api.github.com/users/jmattheis/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-02-24T12:19:07Z","updated_at":"2018-02-24T12:49:14Z","closed_at":null,"merged_at":null,"merge_commit_sha":"6e3e601eafdb39f0935787ba231b847c6d9465ec","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/gotify/server/pulls/16/commits","review_comments_url":"https://api.github.com/repos/gotify/server/pulls/16/comments","review_comment_url":"https://api.github.com/repos/gotify/server/pulls/comments{/number}","comments_url":"https://api.github.com/repos/gotify/server/issues/16/comments","statuses_url":"https://api.github.com/repos/gotify/server/statuses/0ddb9ee84318d4c6a8f509accb7c3ca5b7c29c41","head":{"label":"gotify:makefile","ref":"makefile","sha":"0ddb9ee84318d4c6a8f509accb7c3ca5b7c29c41","user":{"login":"gotify","id":36410427,"avatar_url":"https://avatars2.githubusercontent.com/u/36410427?v=4","gravatar_id":"","url":"https://api.github.com/users/gotify","html_url":"https://github.com/gotify","followers_url":"https://api.github.com/users/gotify/followers","following_url":"https://api.github.com/users/gotify/following{/other_user}","gists_url":"https://api.github.com/users/gotify/gists{/gist_id}","starred_url":"https://api.github.com/users/gotify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gotify/subscriptions","organizations_url":"https://api.github.com/users/gotify/orgs","repos_url":"https://api.github.com/users/gotify/repos","events_url":"https://api.github.com/users/gotify/events{/privacy}","received_events_url":"https://api.github.com/users/gotify/received_events","type":"Organization","site_admin":false},"repo":{"id":117591846,"name":"server","full_name":"gotify/server","owner":{"login":"gotify","id":36410427,"avatar_url":"https://avatars2.githubusercontent.com/u/36410427?v=4","gravatar_id":"","url":"https://api.github.com/users/gotify","html_url":"https://github.com/gotify","followers_url":"https://api.github.com/users/gotify/followers","following_url":"https://api.github.com/users/gotify/following{/other_user}","gists_url":"https://api.github.com/users/gotify/gists{/gist_id}","starred_url":"https://api.github.com/users/gotify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gotify/subscriptions","organizations_url":"https://api.github.com/users/gotify/orgs","repos_url":"https://api.github.com/users/gotify/repos","events_url":"https://api.github.com/users/gotify/events{/privacy}","received_events_url":"https://api.github.com/users/gotify/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gotify/server","description":"Gotify is a notification server.","fork":false,"url":"https://api.github.com/repos/gotify/server","forks_url":"https://api.github.com/repos/gotify/server/forks","keys_url":"https://api.github.com/repos/gotify/server/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gotify/server/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gotify/server/teams","hooks_url":"https://api.github.com/repos/gotify/server/hooks","issue_events_url":"https://api.github.com/repos/gotify/server/issues/events{/number}","events_url":"https://api.github.com/repos/gotify/server/events","assignees_url":"https://api.github.com/repos/gotify/server/assignees{/user}","branches_url":"https://api.github.com/repos/gotify/server/branches{/branch}","tags_url":"https://api.github.com/repos/gotify/server/tags","blobs_url":"https://api.github.com/repos/gotify/server/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gotify/server/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gotify/server/git/refs{/sha}","trees_url":"https://api.github.com/repos/gotify/server/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gotify/server/statuses/{sha}","languages_url":"https://api.github.com/repos/gotify/server/languages","stargazers_url":"https://api.github.com/repos/gotify/server/stargazers","contributors_url":"https://api.github.com/repos/gotify/server/contributors","subscribers_url":"https://api.github.com/repos/gotify/server/subscribers","subscription_url":"https://api.github.com/repos/gotify/server/subscription","commits_url":"https://api.github.com/repos/gotify/server/commits{/sha}","git_commits_url":"https://api.github.com/repos/gotify/server/git/commits{/sha}","comments_url":"https://api.github.com/repos/gotify/server/comments{/number}","issue_comment_url":"https://api.github.com/repos/gotify/server/issues/comments{/number}","contents_url":"https://api.github.com/repos/gotify/server/contents/{+path}","compare_url":"https://api.github.com/repos/gotify/server/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gotify/server/merges","archive_url":"https://api.github.com/repos/gotify/server/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gotify/server/downloads","issues_url":"https://api.github.com/repos/gotify/server/issues{/number}","pulls_url":"https://api.github.com/repos/gotify/server/pulls{/number}","milestones_url":"https://api.github.com/repos/gotify/server/milestones{/number}","notifications_url":"https://api.github.com/repos/gotify/server/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gotify/server/labels{/name}","releases_url":"https://api.github.com/repos/gotify/server/releases{/id}","deployments_url":"https://api.github.com/repos/gotify/server/deployments","created_at":"2018-01-15T20:25:27Z","updated_at":"2018-02-18T18:22:18Z","pushed_at":"2018-02-24T12:23:27Z","git_url":"git://github.com/gotify/server.git","ssh_url":"git@github.com:gotify/server.git","clone_url":"https://github.com/gotify/server.git","svn_url":"https://github.com/gotify/server","homepage":"","size":91,"stargazers_count":2,"watchers_count":2,"language":"Go","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":1,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":0,"open_issues":1,"watchers":2,"default_branch":"master"}},"base":{"label":"gotify:master","ref":"master","sha":"fb6bb484a41b3f811ac850a3b28c0417a5d8fa87","user":{"login":"gotify","id":36410427,"avatar_url":"https://avatars2.githubusercontent.com/u/36410427?v=4","gravatar_id":"","url":"https://api.github.com/users/gotify","html_url":"https://github.com/gotify","followers_url":"https://api.github.com/users/gotify/followers","following_url":"https://api.github.com/users/gotify/following{/other_user}","gists_url":"https://api.github.com/users/gotify/gists{/gist_id}","starred_url":"https://api.github.com/users/gotify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gotify/subscriptions","organizations_url":"https://api.github.com/users/gotify/orgs","repos_url":"https://api.github.com/users/gotify/repos","events_url":"https://api.github.com/users/gotify/events{/privacy}","received_events_url":"https://api.github.com/users/gotify/received_events","type":"Organization","site_admin":false},"repo":{"id":117591846,"name":"server","full_name":"gotify/server","owner":{"login":"gotify","id":36410427,"avatar_url":"https://avatars2.githubusercontent.com/u/36410427?v=4","gravatar_id":"","url":"https://api.github.com/users/gotify","html_url":"https://github.com/gotify","followers_url":"https://api.github.com/users/gotify/followers","following_url":"https://api.github.com/users/gotify/following{/other_user}","gists_url":"https://api.github.com/users/gotify/gists{/gist_id}","starred_url":"https://api.github.com/users/gotify/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gotify/subscriptions","organizations_url":"https://api.github.com/users/gotify/orgs","repos_url":"https://api.github.com/users/gotify/repos","events_url":"https://api.github.com/users/gotify/events{/privacy}","received_events_url":"https://api.github.com/users/gotify/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gotify/server","description":"Gotify is a notification server.","fork":false,"url":"https://api.github.com/repos/gotify/server","forks_url":"https://api.github.com/repos/gotify/server/forks","keys_url":"https://api.github.com/repos/gotify/server/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gotify/server/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gotify/server/teams","hooks_url":"https://api.github.com/repos/gotify/server/hooks","issue_events_url":"https://api.github.com/repos/gotify/server/issues/events{/number}","events_url":"https://api.github.com/repos/gotify/server/events","assignees_url":"https://api.github.com/repos/gotify/server/assignees{/user}","branches_url":"https://api.github.com/repos/gotify/server/branches{/branch}","tags_url":"https://api.github.com/repos/gotify/server/tags","blobs_url":"https://api.github.com/repos/gotify/server/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gotify/server/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gotify/server/git/refs{/sha}","trees_url":"https://api.github.com/repos/gotify/server/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gotify/server/statuses/{sha}","languages_url":"https://api.github.com/repos/gotify/server/languages","stargazers_url":"https://api.github.com/repos/gotify/server/stargazers","contributors_url":"https://api.github.com/repos/gotify/server/contributors","subscribers_url":"https://api.github.com/repos/gotify/server/subscribers","subscription_url":"https://api.github.com/repos/gotify/server/subscription","commits_url":"https://api.github.com/repos/gotify/server/commits{/sha}","git_commits_url":"https://api.github.com/repos/gotify/server/git/commits{/sha}","comments_url":"https://api.github.com/repos/gotify/server/comments{/number}","issue_comment_url":"https://api.github.com/repos/gotify/server/issues/comments{/number}","contents_url":"https://api.github.com/repos/gotify/server/contents/{+path}","compare_url":"https://api.github.com/repos/gotify/server/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gotify/server/merges","archive_url":"https://api.github.com/repos/gotify/server/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gotify/server/downloads","issues_url":"https://api.github.com/repos/gotify/server/issues{/number}","pulls_url":"https://api.github.com/repos/gotify/server/pulls{/number}","milestones_url":"https://api.github.com/repos/gotify/server/milestones{/number}","notifications_url":"https://api.github.com/repos/gotify/server/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gotify/server/labels{/name}","releases_url":"https://api.github.com/repos/gotify/server/releases{/id}","deployments_url":"https://api.github.com/repos/gotify/server/deployments","created_at":"2018-01-15T20:25:27Z","updated_at":"2018-02-18T18:22:18Z","pushed_at":"2018-02-24T12:23:27Z","git_url":"git://github.com/gotify/server.git","ssh_url":"git@github.com:gotify/server.git","clone_url":"https://github.com/gotify/server.git","svn_url":"https://github.com/gotify/server","homepage":"","size":91,"stargazers_count":2,"watchers_count":2,"language":"Go","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":1,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":0,"open_issues":1,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/gotify/server/pulls/16"},"html":{"href":"https://github.com/gotify/server/pull/16"},"issue":{"href":"https://api.github.com/repos/gotify/server/issues/16"},"comments":{"href":"https://api.github.com/repos/gotify/server/issues/16/comments"},"review_comments":{"href":"https://api.github.com/repos/gotify/server/pulls/16/comments"},"review_comment":{"href":"https://api.github.com/repos/gotify/server/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/gotify/server/pulls/16/commits"},"statuses":{"href":"https://api.github.com/repos/gotify/server/statuses/0ddb9ee84318d4c6a8f509accb7c3ca5b7c29c41"}},"author_association":"COLLABORATOR"}}
{"actor":{"display_login":"nicories"}}