X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/3d96b7f10a56fcf826693e98f08b673dad8ac256..6ea4eddf936e88c24a6757c0c858812d5ca1a9c6:/docs/usage_and_configuration/black_as_a_server.md diff --git a/docs/usage_and_configuration/black_as_a_server.md b/docs/usage_and_configuration/black_as_a_server.md index 75a4d92..fc9d1ca 100644 --- a/docs/usage_and_configuration/black_as_a_server.md +++ b/docs/usage_and_configuration/black_as_a_server.md @@ -4,10 +4,15 @@ protocol. The main benefit of using it is to avoid the cost of starting up a new _Black_ process every time you want to blacken a file. +```{warning} +`blackd` should not be run as a publicly accessible server as there are no security +precautions in place to prevent abuse. **It is intended for local use only**. +``` + ## Usage `blackd` is not packaged alongside _Black_ by default because it has additional -dependencies. You will need to execute `pip install black[d]` to install it. +dependencies. You will need to execute `pip install 'black[d]'` to install it. You can start the server on the default port, binding only to the local interface by running `blackd`. You will see a single line mentioning the server's version, and the