{"action":"created","issue":{"url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/issues/405","repository_url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py","labels_url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/issues/405/labels{/name}","comments_url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/issues/405/comments","events_url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/issues/405/events","html_url":"https://github.com/elastic/elasticsearch-dsl-py/issues/405","id":154473828,"number":405,"title":"Link to the elasticsearch-py docs in the configuration section","user":{"login":"edmorley","id":501702,"avatar_url":"https://avatars.githubusercontent.com/u/501702?v=3","gravatar_id":"","url":"https://api.github.com/users/edmorley","html_url":"https://github.com/edmorley","followers_url":"https://api.github.com/users/edmorley/followers","following_url":"https://api.github.com/users/edmorley/following{/other_user}","gists_url":"https://api.github.com/users/edmorley/gists{/gist_id}","starred_url":"https://api.github.com/users/edmorley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edmorley/subscriptions","organizations_url":"https://api.github.com/users/edmorley/orgs","repos_url":"https://api.github.com/users/edmorley/repos","events_url":"https://api.github.com/users/edmorley/events{/privacy}","received_events_url":"https://api.github.com/users/edmorley/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/labels/documentation","name":"documentation","color":"bfe5bf"}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-05-12T12:47:06Z","updated_at":"2016-06-29T08:26:35Z","closed_at":"2016-06-28T23:20:56Z","body":"At the moment the [configuration section](http://elasticsearch-dsl.readthedocs.io/en/latest/configuration.html) says:\r\n```\r\nDefault connection\r\n------------------\r\n\r\nTo define a default connection that will be used globally, use the\r\n``connections`` module and the ``create_connection`` method:\r\n\r\n.. code:: python\r\n\r\n    from elasticsearch_dsl.connections import connections\r\n\r\n    connections.create_connection(hosts=['localhost'], timeout=20)\r\n\r\nAny keyword arguments (``hosts`` and ``timeout`` in our example) will be passed\r\nto the ``Elasticsearch`` class.\r\n```\r\n\r\nFrom this it wasn't immediately clear:\r\n* That the `Elasticsearch` class mentioned was actually from the `elasticsearch-py` package and not this one\r\n* What the other options were for the connection (eg for auth)\r\n* Most importantly: That the default settings are insecure, since SSL certificates are not verified (see https://elasticsearch-py.readthedocs.io/en/master/#ssl-and-authentication)\r\n\r\nIn the end, it was only through code inspection of elasticsearch-dsl-py and then manually googling for the elasticsearch-py repo (since there isn't a link to it from the repo readme or read the docs) that led me to:\r\nhttps://elasticsearch-py.readthedocs.io/en/master/#ssl-and-authentication\r\nhttps://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch\r\n\r\nI think it would be good to:\r\n* make all mentions of elasticsearch-py in the docs/readme link to https://github.com/elastic/elasticsearch-py\r\n* add a \"for more details on connection options, see <elasticsearch-py docs page X>\" to the configuration docs\r\n* ideally also add a warning about not verifying certificates directly to the configuration page, in case people get set up without having read the elasticsearch-py docs first. (Not verifying certs by default is a **massive** footgun on the part of elasticsearch-py IMO, but that's a battle to fight another day.)\r\n\r\nI'll try to open a PR if I get a moment, but if someone wants to beat me to it, then by all means :-)"},"comment":{"url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/issues/comments/229290294","html_url":"https://github.com/elastic/elasticsearch-dsl-py/issues/405#issuecomment-229290294","issue_url":"https://api.github.com/repos/elastic/elasticsearch-dsl-py/issues/405","id":229290294,"user":{"login":"edmorley","id":501702,"avatar_url":"https://avatars.githubusercontent.com/u/501702?v=3","gravatar_id":"","url":"https://api.github.com/users/edmorley","html_url":"https://github.com/edmorley","followers_url":"https://api.github.com/users/edmorley/followers","following_url":"https://api.github.com/users/edmorley/following{/other_user}","gists_url":"https://api.github.com/users/edmorley/gists{/gist_id}","starred_url":"https://api.github.com/users/edmorley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edmorley/subscriptions","organizations_url":"https://api.github.com/users/edmorley/orgs","repos_url":"https://api.github.com/users/edmorley/repos","events_url":"https://api.github.com/users/edmorley/events{/privacy}","received_events_url":"https://api.github.com/users/edmorley/received_events","type":"User","site_admin":false},"created_at":"2016-06-29T08:26:35Z","updated_at":"2016-06-29T08:26:35Z","body":"Many thanks :-)\r\n\r\nI wonder if it's also worth doing this part:\r\n\r\n> ideally also add a warning about not verifying certificates directly to the configuration page, in case people get set up without having read the elasticsearch-py docs first. (Not verifying certs by default is a massive footgun on the part of elasticsearch-py IMO, but that's a battle to fight another day.)"}}
{"actor":{"display_login":"edmorley"}}