{
"info": {
"author": "Paul Butler",
"author_email": "notify@paulbutler.org",
"bugtrack_url": null,
"classifiers": [],
"description": "Self-hosting `Notify.run `__ (BETA)\n========================================================\n\nIntroduction\n------------\n\nIn addition to using the public `notify.run `__ server, it is possible to host your own.\n\nQuick Start\n-----------\n\n::\n\n pip install notify-run-server\n notify-run-server\n\nOnce the server is running, you can visit `localhost:5000 `_ to access a local version of notify.run.\n\nConfiguration\n-------------\n\nAll configuration of ``notify-run-server`` is done through setting environment variables.\n\nDatabase\n~~~~~~~~\n\n``notify-run-server`` needs a database backend to store subscription information and notification history. By default, it uses a sqlite database called ``notify.sqlite`` in the current working directory. All database access happens through `SQLAlchemy `_, so it is possible to replace sqlite with another supported backend like MySQL or Postgres. Note, however, that not all backends support the JSON field type, which is required by ``notify-run-server``.\n\nTo configure the database, set the environment variable ``NOTIFY_DB_URL`` to a URI that conforms to `SQLAlchemy\u2019s URL schema `_. The server will create the required tables the first time it connects to the database.\n\nAlternatively, ``notify-run-server`` can use Amazon DynamoDB as a backend. This is used for the main production deployment, `notify.run `__. To use this option, create two DynamoDB tables for channels and messages (see `serverless.yml `_ for the schema). Then set up the Python ``boto`` package with your AWS credentials and set the ``NOTIFY_DB_URL`` with the format ``dynamodb::``.\n\nServer URL\n~~~~~~~~~~\n\nBy default, ``notify-run-server`` assumes that it is running at the hostname given in the HTTP request. This breaks if it is running behind a reverse proxy or similar setup. In these cases, you can set the environment variable ``NOTIFY_WEB_SERVER`` to the root URL of the server, e.g. ``https://notify.run/``.\n\nVAPID Configuration\n~~~~~~~~~~~~~~~~~~~\n\nThe web push protocol used by `notify.run `__ uses public key encryption to authenticate subscriptions. ``notify-run-server`` includes a built-in key pair that is fine for personal use, but for public instances you should generate your own key pair (e.g. using `this tool `_) and pass them to ``notify-run-server`` with the ``NOTIFY_VAPID_PRIVKEY`` and ``NOTIFY_VAPID_PUBKEY`` environment variables, for the private and public keys, respectively.",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://notify.run/",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "notify-run-server",
"package_url": "https://pypi.org/project/notify-run-server/",
"platform": "",
"project_url": "https://pypi.org/project/notify-run-server/",
"project_urls": {
"Homepage": "https://notify.run/"
},
"release_url": "https://pypi.org/project/notify-run-server/0.0.5/",
"requires_dist": null,
"requires_python": ">=3.5",
"summary": "Server for self-hosted notify.run server.",
"version": "0.0.5"
},
"last_serial": 5437556,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "37a87a498ffb95b9d5f515a02fdb2a6e",
"sha256": "465efe0553ed6539c473602019fe0ce00c9cc84ce009882111e85d710b815e50"
},
"downloads": -1,
"filename": "notify-run-server-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "37a87a498ffb95b9d5f515a02fdb2a6e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 579553,
"upload_time": "2019-05-12T21:14:58",
"url": "https://files.pythonhosted.org/packages/f6/8f/a91e5f8328ffd4294c7dc6b800baa891584bb39b1a64c9986a3076f696a9/notify-run-server-0.0.1.tar.gz"
}
],
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "2481d5711e8c1789f784001ae55c5eeb",
"sha256": "befe77ffa49de99118eec15e9a8abc58ec28b7f79f571508c19eaafce22bd1dd"
},
"downloads": -1,
"filename": "notify-run-server-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "2481d5711e8c1789f784001ae55c5eeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 579554,
"upload_time": "2019-05-12T21:47:28",
"url": "https://files.pythonhosted.org/packages/a5/fe/1f6e7641e46a8cd036f0609246a9e8816c2d8149d44314f43fd6eddbc885/notify-run-server-0.0.2.tar.gz"
}
],
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "bacf071a791185725604aeb8e02fd5f1",
"sha256": "c2e9b3c02f18a1258a42476858860874964e029fa974deb70090ce30aaff3b16"
},
"downloads": -1,
"filename": "notify-run-server-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "bacf071a791185725604aeb8e02fd5f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 579558,
"upload_time": "2019-05-12T23:40:38",
"url": "https://files.pythonhosted.org/packages/c1/81/8b7cb64081d701f8a430bf2adddea5c3e08876913f9284ba39e82d9ad80e/notify-run-server-0.0.3.tar.gz"
}
],
"0.0.4": [
{
"comment_text": "",
"digests": {
"md5": "c563af66b95778b79b897bac0a057eb4",
"sha256": "d84aca3ca88c8dc79f93032438c261af4738f51e587302ea9fa00758067bdcd1"
},
"downloads": -1,
"filename": "notify-run-server-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c563af66b95778b79b897bac0a057eb4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 581796,
"upload_time": "2019-05-18T19:16:53",
"url": "https://files.pythonhosted.org/packages/3c/7a/65e356e1dc60740a0f9897642fdd345ce570d8b8b259bbeeba78da9bf6f9/notify-run-server-0.0.4.tar.gz"
}
],
"0.0.5": [
{
"comment_text": "",
"digests": {
"md5": "5f82b95c2cb45990bd649e648f4a96a9",
"sha256": "8067b4be8fa31e71c9621d7342aa6f6e1b5170491463bbf4238bdbbf65bdfaeb"
},
"downloads": -1,
"filename": "notify-run-server-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5f82b95c2cb45990bd649e648f4a96a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 581885,
"upload_time": "2019-06-23T15:21:18",
"url": "https://files.pythonhosted.org/packages/5d/fe/9402970b43c4159a189277aca617714e4242033c9cd1246f61408d96a0db/notify-run-server-0.0.5.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "5f82b95c2cb45990bd649e648f4a96a9",
"sha256": "8067b4be8fa31e71c9621d7342aa6f6e1b5170491463bbf4238bdbbf65bdfaeb"
},
"downloads": -1,
"filename": "notify-run-server-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5f82b95c2cb45990bd649e648f4a96a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 581885,
"upload_time": "2019-06-23T15:21:18",
"url": "https://files.pythonhosted.org/packages/5d/fe/9402970b43c4159a189277aca617714e4242033c9cd1246f61408d96a0db/notify-run-server-0.0.5.tar.gz"
}
]
}