Crow/docs/guides/ssl.md

Crow supports HTTPS though SSL or TLS.<br><br>

!!! note

    When mentioning SSL in this documentation, it is often a reference to openSSL, which includes TLS.<br><br>


To enable SSL, first your application needs to define either a `.crt` and `.key` files, or a `.pem` file. Once you have your files, you can add them to your app like this:<br>
`#!cpp app.ssl_file("/path/to/cert.crt", "/path/to/keyfile.key")` or `#!cpp app.ssl_file("/path/to/pem_file.pem")`. Please note that this method can be part of the app method chain, which means it can be followed by `.run()` or any other method.<br><br>

You also need to define `CROW_ENABLE_SSL` in your compiler definitions (`g++ main.cpp -DCROW_ENABLE_SSL` for example) or `set(CROW_FEATURES ssl)` in `CMakeLists.txt`.

You can also set your own SSL context (by using `asio::ssl::context ctx`) and then applying it via the `#!cpp app.ssl(ctx)` method.<br><br>

!!! warning

    If you plan on using a proxy like Nginx or Apache2, **DO NOT** use SSL in crow, instead define it in your proxy and keep the connection between the proxy and Crow non-SSL.
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`Crow supports HTTPS though SSL or TLS.<br><br>`

documented CROW_FEATURES 2022-04-07 12:42:47 +00:00			`!!! note`
changed json and app code (relating to blueprints and initializer list) also snuck in some guide updates 2021-10-10 11:42:36 +00:00
			`When mentioning SSL in this documentation, it is often a reference to openSSL, which includes TLS.<br><br>`

Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
			To enable SSL, first your application needs to define either a `.crt` and `.key` files, or a `.pem` file. Once you have your files, you can add them to your app like this:<br>
			`#!cpp app.ssl_file("/path/to/cert.crt", "/path/to/keyfile.key")` or `#!cpp app.ssl_file("/path/to/pem_file.pem")`. Please note that this method can be part of the app method chain, which means it can be followed by `.run()` or any other method.<br><br>

documented CROW_FEATURES 2022-04-07 12:42:47 +00:00			You also need to define `CROW_ENABLE_SSL` in your compiler definitions (`g++ main.cpp -DCROW_ENABLE_SSL` for example) or `set(CROW_FEATURES ssl)` in `CMakeLists.txt`.
changed json and app code (relating to blueprints and initializer list) also snuck in some guide updates 2021-10-10 11:42:36 +00:00
replace boost::asio with standalone asio. 2022-06-06 14:38:46 +00:00			You can also set your own SSL context (by using `asio::ssl::context ctx`) and then applying it via the `#!cpp app.ssl(ctx)` method.<br><br>
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00
updated documentation to fix a few mistakes, clear up a few points, and added compression guide 2021-06-03 14:12:48 +00:00			`!!! warning`
replace boost::asio with standalone asio. 2022-06-06 14:38:46 +00:00
updated documentation to fix a few mistakes, clear up a few points, and added compression guide 2021-06-03 14:12:48 +00:00			`If you plan on using a proxy like Nginx or Apache2, DO NOT use SSL in crow, instead define it in your proxy and keep the connection between the proxy and Crow non-SSL.`