From 658ab75049b67d79ee8690b78e9b523115e6901b Mon Sep 17 00:00:00 2001 From: florian Date: Mon, 11 Jul 2022 07:51:56 +0200 Subject: [PATCH] docs - add ansible diagram --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- docs/assets/img/integration-ansible.svg | 4 ++++ docs/diagrams/integration-ansible.drawio | 1 + docs/integrations.md | 29 ++++++++++------------- 4 files changed, 19 insertions(+), 17 deletions(-) create mode 100644 docs/assets/img/integration-ansible.svg create mode 100644 docs/diagrams/integration-ansible.drawio diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 331251c4..c9793e13 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: "[FEATURE]" -labels: feature +labels: enhancement assignees: '' --- diff --git a/docs/assets/img/integration-ansible.svg b/docs/assets/img/integration-ansible.svg new file mode 100644 index 00000000..18cf9123 --- /dev/null +++ b/docs/assets/img/integration-ansible.svg @@ -0,0 +1,4 @@ + + + +

LINUX MACHINE

LINUX MACHINE
WEB SERVICES
WEB SERVICES
INTERNAL TRAFFIC
(same machine)
INTERNAL TRAFFIC...
INCOMING TRAFFIC
INCOMING TRAFFIC
INTERNAL TRAFFIC
(other machines)
INTERNAL TRAFFIC...ANSIBLE ROLEINSTALLATION + CONFIGURATIONText is not SVG - cannot display \ No newline at end of file diff --git a/docs/diagrams/integration-ansible.drawio b/docs/diagrams/integration-ansible.drawio new file mode 100644 index 00000000..b64ee237 --- /dev/null +++ b/docs/diagrams/integration-ansible.drawio @@ -0,0 +1 @@ +7XtZk6NIkvCvKbPdh07jRjxy3zcIwctnXOIGiUMcv34hr8qsyvqmZ6Z7pndtZGkpcCI8CL893PUNppuF78NbrnZJWn+DgGT5BjPfIAhEIOjb8Qck6wvkBAEvgKwvktdB3wF2saWvwLdhU5Gkw6eBY9fVY3H7DIy7tk3j8RMs7Ptu/jzs2tWfV72FWfoTwI7D+meoVyRj/goFAeD7AyEtsvx16RP6+qAJ3wa/AoY8TLr5Awhmv8F033Xjy1Wz0Gl9EO+NLi/zuF88fX+xPm3H3zNhwUSg0Qn9ut7sEtiycxVNvyEvWB5hPb1u+BuE1Ts+6rZfZMfFG+Da7evsjAzH8Lfj+rehj5+nYPfp2AOVj+PBFPJ4BYg7hgxPWddldRreiuEp7podHA/7EO4aNkV9SATdtUNXh8N3LAeTwjj9hPnLUXFXd/2nYd8gGIRQDD99BH3eRPRv29XLsoqouZd9PZWkBVFj397iFfOPL7eDf3rhXw/9wLFneRvXNyHuu6lN0kMOwP3xnBdjat9eiDzvavu8y6Z+ffxI+7HYFYCsi6zdYWN3DKjDKK2NbijGojug8S51af9huPLDgKZIkmN9KnzF8z5jGPuuSul39r0x7e3FP4r0q5Qfi6TLB9CriPNp16Rjv+5DXp9Cb/r3am8g/PV+/q69yNuY/IPiQsQrMHy1GNk77u9KtV+86tXfoWPwTzrmsYcA26x1FmnW/ufYdQgD95PgvcDtbuqfp70IMYQeYowegoz+SpTRF2Heh76J8375I94PvOOePwe8qOuvePqZ223Xpn8MoxEQfQII4PsH/sR3FPiZ7yBIPJ3An1mP/FmcB78yr/8Usz8Q+ZWUf6o2wSj6iaowgvxE1XfyfSTpn6ZMIPq3Sbp72ttxWTTPzv2XJirqxnGX+VfjRoVxlT1z442YSXoNp2fr+rVNDIfbS8hxLZaDg9TzguQbFHiDHKh2/7I7kZfb3VS32TeILs6Ubs2AzGcduX80281ZN9uvLHH/R+k06e/fzMBIVXQM4C8W5wmWE0EBkEDcGpgUFfBEEdiUFHlcG5yl2vcsNI7r2jhmopZksZybav1wcYlOiOPgsoEpDbtSOkDXAmktmjAhPPWI7HBwoHTGakKjG0j9BlHmmCWMwrL6Y6zuHHnnbLIbOVJCgQoQMhShJ8ekIJubmEI4yyWAUODu0DgiZdzYHT1IKQRd9yV3TuKif1wft7YFvBuUwBHcwMCG7UuchGKf4QCjom/7kpxBoI+E2P03BQ85qyHiQwCUXbG5Hi1L7bFfpK2x/+8W1PFoYR8HFajFDAtpgpnF8opj3O8p1Um3GaNFvJ5pmii1mPFBwpCdQRpOLJgu4m5yKUdE+MwLu/wUA4AQZIiNmTvmaut5EPJPd7Ed9zk3ncy2DjRtvyxVDMP9chlp+eojACGTg5qGOmmaKmY6zcFRTnwETt52GEP1c3ShdGOQcIsRejOw7XmXbe6gK4dIpQF4p1KyzPh28jAbKeMASMWetTSLVUzNn5hhFxMqWmI2o1FJBBWKyK/jzJrzDn7QMXRsXS17D21p1DfwBOBQWwcWxC9o1z0zuAOXnXVqqwLuzyjVwSlnJrrqmvdLdkJTt1gfhUMrBzZaY7tGCYWFjAvCa9UZt1Wn330EVTBjIyVBeuMlCbHE85k7JeYogPMWScE9yJcqaqlJ3keWrBdfgj0oobIBzmjYlvUHnOEyPkf1BlY7XCghLeyscood3LagCztKQYXlFzGXNUmTaqPV0o20aoVNTodILKt+Gge0uhTSDLNSX5nwISC1/OgBhYnOs03fbYEw+IsdtYKVVQ+Duzamg5YbDueau4UoafIaeE+7mun8Tt/f4SBpfI48ynZKvNtvbvh1EvEMFtKRhBTQmmtP5O/BDBZXPqSl2KG6h9G7faw6CQ+bMwtC9R6QcfI8hz52tUWLFMYNuRkqUo2EVwluOhG1tliu2JOC2UsldbqUUqJeJvqkj/y5rNTKuiyKrJPnZF4xA0Kzh8D0k3dBrQorWzErJqWuSNeyPWydMROFaaaYA3CarpUniDEKzd6oczQgIAp34XqobNQwWZcqlqsbzK/hqZcZ7YbOaoQFLRWve/wJ8ipW9mroID0tisOgzTelmdLEv8pOudvdq8qu19TqStZs0c6ATpiysI8s9mL05I6m2PGpJeYXgYBsKewjpiwwVVgTBlGuvD/jFHnFwYOcTKl5KbJ7JuPK6bBFyRI/Iry4+a2fU77FKY3Jd9XGdNigYnRNmdciIPLS3j8cHPnYnV/XCFDAZtZQUOQFDmD4zckzlu/skRzPIA1hYIiPQaYoAAPmC+0eKps3zWILCy+xRnwItOtPi2pOIz3YK5iQovyAsuoCllEEyuYMi6laUrrOSyDLSxklotw91u91APRlq4WNrWY1EFfLCB6oNvo8QODqMaptEzuAXFTy1Iyej1o6eD5WO4XU2WoCiBWrobMr9XGIqcpZUopsI4WzTSzoExTaTaX2Nz7JrvZ9N6DFmPO31lXUO2tQAvoQH1WOp1siozkq2VzBp/HJdLQ9EONszlP2r42nraLzJozfF63gCr1IqxAhp/v+7NFIh2iDiVUVunHvFZSplDpfT8t5vhUaCPT3BawbEwJzxxCuywWsz5rYGewkSvr8yFd3RwJVcxWI5XlGVqae8ccNy0eFVs8xCrMYCMruGR3987YNFqztw70qguvDS+zXek63TmNFTN9YYnIuTFORu7rgddiRbki3R5Q14cYbhjk8TEMPcQJU5Z5feGTXSq7MFBZi0eB04zw6vnE9YMG9rN24tGCpFI7ZMxDFuSHv8QwFlPcbx9rZumaFFAQrpmCCb1DMZacQhQ+PiTu4dra6aPfZURHahshxUTFeqXNtETRK4IN5KbfGPC+YGfnwTOQ+BEYCL8BBn+3m5tgQfA+D1j3bbn+fLRwpGvwxaRDP+xc327YJyB5Dw1+m1smk+REWe6RDrf68bBciLgZsVUTCcxvlAvMPnWJaN+4g/JrMQsM20EoATccGlqI0iDtM7EwkD+rcNVFlX24Im6+H5ztRpvFwXfMEyuJoWMtOIzyIZ+wCMeoVNpX6gkYnxkJPMtpRmN2nPMKT/Q2xH8PISAbgx3krPg6Lx1Gwj6KYM9zkE62658PkQVQAAA2uKFwCvTokg7l4FHYCopoTKNEzXDxwNfqSQUVeGjx7Q7mbzLDi2XDPpXdagmu9mGvrw90hNqBVJRFggzPjHcw0dJxHb+VdH6g1ChwIHArULQVTOMedeomsRO4oAPVcDLUvFipe9CGKIKvET5PCj6d7Y9mdYwOgFeSXhfDvRRUwAwI+vNN5D45a6UHI+jmGN82e0T0UpdqRMgs5S/tOTFL4IgUiWGI2fYscl2fDIyt2aEx9xPwqEqtqZt5UAPdqpaBbsQ0IPO0xzBFtDGClaqayrACrhX5wcSzhcBhQiTDagA93UAo6okc4fj4HO1zGbRsdsshVPXAxkQRLgpr2LpdZ6BC1vnSjg80leg9x2etYvY/EsSW0XZSChGsoA9l6h5ZBDeA0KRlUj9gyx2osjmE9lwSi5n4OdxvTrrOuloEF3JiVue+mibkNZ+dWCCi5bmrJiRNk7BTgLp1UYajGwHla5ZwE+EInDRY1SDbDo/zI65fQEB6gGKc8mlSD187XilWyIdwjZU5hJdTxQRwUJDIaHZg32gU0tADcgxlK2dTsRHst4Na+BC0R6MVZkCLyaO9BYzbgWwcTlY0TvnI6WIFts45PCEZpOG8DbNTCykAzES+XCHRuZzZNiHy544wrCiSKmBIknOic2LrYdAJ0OGH8yWHc4iISl93S0A5fTWIzZLLrJ+HNysmLiBpozvqwtyZDQ5YQKoeuY1v+HHs8Kzjcfdpf4l6ym+/N+UWLa01IBmeHSSGuG2OjA0Yp8bAC5w1bOu1ibmADjg5XqFTmHclIFRVk5CPxrYLxim/gwxis8cU67E7qanNUyMntyiJKUl37YWhVbg0hweMGpi19kdVRFwngDVKAysqCypwBJsPVGixwh0O0ylhuTr5O22N4DJFBLVHbQIrB7caWf9gVhp0mWzo/xGTXIqopHSKHxali11Cwz7gLOzbSrvT8WBjCByAGZpHNokBUQBEur5U7cBq8qSwJdoSiONijJaIRV8JB5VoFb6P5iMxFORPOfcrWJDCJFdxl2OeBJCIHJhoCuoWP0K1x1yFpeROWxplPytk4K5EcENosybM9eZWcy2xkxfnt+SyMslRiHoIAWvBsjjYW1MgTum0cevinQx7arHcMO+kH7Xw96Bu5QN1BuVaBhlOqyTWXpUWpoGmcDdihgmUg7ooyJdp9ugCMj92ueZ0zku4xe8ABdCk5Gx4ODOJapuB1x6+Li3BVLdhSFhTLKSUD8BYMvQujrhXkNpLYh1mWzJBq6qVfpbmAtXYjHdZaLaocUJb6iNiDyYdlq+nr1ZdkTJYTWZs7pr+F+7KZzHsGwzY5w1u3FEQuhNEdLu/OSvOUqlb9KCb+/lCurGmTh2296tYlWFcuHHTiFHY8aa/eQwQJrimLO67F3R7Gk6t/teKzbVrlWMP6SSEUmsb1qnNYbXO168gT8h6lb+GizUjFiks9WoimTUB9BRsV2yY7WfAVyMxzNd/83bc/oBwQpM07x+W5Bk53sMvTk1kVriBFpiI9uwEW6zY9GepoIgxhpJ06qe1JC+o8PQcTG5xdQuLOfk0lzJ2deceuF/Vm7GF/4XAEeE2xoUlau3uYxxEoxzWHz78mj3Dfs7aENS7fsz2nAfIghSY7SmqigG0hhDfAN9cc7K40oGQumUl0ZpMVCwsliEmcfgRKg8Pme9JIjf5yvYOk1XTG5eBtsBsOoOTs3WVx1p2sM0JpbSo5VjwsUw4SQ24QxaZc2w2PQNzkWoHysDY644fKQ0dyObECa1UWWQFG56qLv9sHblJLFD3ySMM8/KoBl1mYXitQENrLsalnXxvEyZxDCkGboi3mntjjL4e/MO9F7Y7Yv5b4kKZ6zlr0QKlgmIl05lKsW4BwzpKZWLCueZvCbHfLMhvYrDWfTuKy4V36yBnigWuIjsyn2CARK9+M65WoUWwcBOKxjQdNVGHLYvzYeuqyp4u1PLT8ohsdahj6nB7+igVRHMOGx9yqEN6sAgqlt8e8ORT4oBITQRcUIQQBT6f24UwOj3BBYIi0mIusqp4H5SGO2BHNutUgmmRwZDQRuKsoVcMmm5MMI5cHJQw/PEg2iSAS0eSeT4fwSKC2KnRZZxeU2a97fmMoD8PIw8mbadasKdZhcJgoCC7sFJEy5+HOrmlAd3KDqFE5Pa5El/BH/h0z0JkYDD2oWZtM6YNhBP9o7x5BSJvT1Ol4mR9HUgEDrp0JCokpD2Hb6kekQI4dAKR94ezc0EnFyAhS4ePW6K07vyHC0LWsxJoVSVeDcTlvewownz2L9dnnI4YjiifF3S+tsSWShC42DGly/lplCpPPxp0MTZJa6LBoOxEO1+xK5zA+3eWRQucoLPvmdNXzMUUOPlDp/THyADnIY+2rsEFmUcEbey7EzSdDdiYg0gSeFpKqRYw+81v2TFK2exf4bbnQsDBVyDp02nYxYACvzIKq9SNkIfXkSCzYe1eTOSuRZpWJA5UX2dYzu1RbWSJwC2FpgOcy7prlBcapVwYHaCkQeBTRmfb+nNf3kTcLRSdH+mWTV7U2V7IQQxrTlYSeEYCXqzNT5qLEQNIEB16fqcm0EWdXshRuehH503E+Y4exa/uSz8h7XOJy7rCwmQylsAEHVaZ2DIWw1OElUaRjzlXRMIASruUDL2hLp69M7V+OXSk9Amj4TecGczyl6FmViFrONZHi5l1/GoQiPIQVeTGXdzMhRlXsZcDxFmrAEw41pLGeo4ctOwLWEjbk0A66olhX68jIa5fQwNA6cpFrjxspnoKjhMdWZtI6X4hm5q62ygiZfdjv3Iu07ZbvpHdtkXIzBhQLvFwzcin8fs9tqN7puYWVRBefyJWbF5OSSW2W24Ox1HUPIageY8BArLKJksX0OKAqCjls5LBKpCIkO7EqydiNZGhIYQ23aCXuLZ5pZErNKGtXJkHrU+GaO9V9vjQYqdaNZ1Jgdu0YNbwPBEWLNpmhsDSVFXKFJsYzCs/CUUMiN9o8oRBGi1nlMvfNz/Sd5SGfyZLIbJAtJ+h8UEnXZ2eSCdbPRZor5ECIn3Mt9TgyCxVlvEs4CZl7NlX6h0MsweMUh0UNcvePHI1Qp7OgEiKvnSWHVOzMWv3OjyQOyp0iLsQ0tyVhk85BGM0JEKnc/TyRacdWeSQsPX5YaX5TmnpickY/YgvuWb2ZbFt2q0t5YZsa1JE8hGdXXLtLT64UpRSg6GikQveBZ7AILaks0xvTLtNTpXDWZg6MeViliyQAEkMt16pfr1dmGCRhoZ6NIiNqW3PK5zLbffKzp+DGIzJVJ3JhLbTKz15ezextFlKzRxUAoJAMm3XqILdZhcN1DzAbdrBrdKCo4X62pfDM03TXwjAwbYeHJ/fwlxW7oS/ZahD2ZBJhYsOv6JUU7tSRrLeM2jYTZybzlbDIWxd0xjXkRcV7cVy7TOdHLq+NYaKsJybcbVh2P/sl57qPnrVwRtwfSxKF7zlJ5LzM2i2wYtG0xZklQ+a+xCxrwFzZgSaLyiZ7FAudDlHQ0cvODztJyRr0LqO3TpCwVjZlLNeMZMk+t9N6D5yOnA85DpNJ2z3rlozSvigex+Z/TL3gBDyBP5QMMOjnQsyJeDoc0I9VAxT5s6oG2O+vGlzrdCGPzoGdJGmbvF4ycR0OQxF/rsd8L94AP5fAEjQ9JcivSmD/6rrdH1TWfa+Z/FTWTZdivByUeEJf7/xXKh3XzPJKpOeb9fXmlyI3vFHgb5XW0uRT/8bPkvlB7L4q+77B+rQOx+LxuevjKzl8XcHoiufGgeVNcolPUo8D6GcULxt6nfWxS+MHRAj+WX3e65hviMawz9LxJ0TPavG+7X9CU/BfdoQkxeOtw0DUHNbabfU+0LFIjhPpD30IH8Z9MfW/hrBJn/tj4rxo0/9+78zov2hp+ITqB33dTdL4WRu/1rOfS6Y/ie6PuvHeu/BVOfYHnf9cDn8vvv6r1fuPqKif0CfwsxgjyNdV9Deb/lGTYPTXSvNPGe+3Bqq/p+T7N/tZ/tGa8M7j6/Pny3Lv1xXhd06/dRHFSQs9FXHXXotdlPrXJqLnGvEeSe7w4bXL57dwTofu0BcOxImDjnXRTstvIHR6OmrI//b2j1+0efzRTT049PTZLL43GHxs6/nCvP9prR3vm/jHI4pXa/R7w4l3gu4ouOJ42+dRXxq9YfcS49s6Ud3F1ScHDf0BHvov4ngRHH7CPxst9PQD03+/70WeoM+4MOxf636h39Ex9IcHqhyH7Z9nLPvbX97E4Ljxvwd0x+13GXm+W/9/Mvh/LsD9q6sCAb0nVW/uG0Sf/sE4FIK/wvav1YWfW71EjdZVUeM/xp3/CQv/3LCQgJ8A/EOf5Q/pPQ68idi/NUY8/dlpSzfmu1C85y3DfxKXv4yE4m9T3o+csCforyCUxL/Bmb+fOv3Hmf9vduY49Pl3DAgIvsv03+vLT9iPuIAn/E/z5Y/5iuRKwQgYsg6JIDfDlP32c7ZEarZIKewOtPTjC9tldyGfjbTtkIpCOqKufTuocPxWgtY1TuRd6xX6PvjT5V+/DfzzMcB0q7sweZqLqmjSpAifuv5oSTjub8f9cVLQNc3LccCYT81R6Tp4c2QJHNkORVSn/6/usu5peBwzQQxDbstvPz55PSqI6+JmvPwqrWiHdPyvnba7FACvX+DpCYa/Q/77L3S48AuH8IX+/vpwCzk9YZ/dxJHz/OgjUOgJx79QavjvdhFH0/r7b/te1Oj7LyRh9n8A \ No newline at end of file diff --git a/docs/integrations.md b/docs/integrations.md index 87cb3c8c..745c38ff 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -878,8 +878,8 @@ BunkerWeb is managed using systemctl : ## Ansible
- ![Overwiew](assets/img/integration-linux.svg){ align=center } -
Linux integration
+ ![Overwiew](assets/img/integration-ansible.svg){ align=center } +
Ansible integration
List of supported Linux distros : @@ -889,36 +889,33 @@ List of supported Linux distros : - Fedora 36 - CentOS Stream 8 -Ansible is an IT automation tool working with python. Ansible work with ssh to connect to remote server, so make sure to have a ssh key. The role will deploy bunkerweb on your remote server. - -First of all download the role from ansible-galaxy: (TODO) - -Next create an inventory by adding the IP adress or FQDN of one or more remote systems, either in `/etc/ansible/hosts` or in your own playbook `inventory.yml` +[Ansible](https://docs.ansible.com/ansible/latest/index.html) is an IT automation tool working with python. Ansible work with ssh to connect to remote server, so make sure to have a ssh key. The role will deploy and configure BunkerWeb on your remote server(s). +First of all download the role from ansible-galaxy : +```shell +ansible-galaxy install bunkerity.bunkerweb ``` + +Next create an inventory by adding the IP adress or FQDN of one or more remote systems, either in `/etc/ansible/hosts` or in your own playbook `inventory.yml` : +```toml [remotehosts] 192.0.2.50 192.0.2.51 192.0.2.52 ``` -The next step we're going to set up the SSH connections so Ansible can connect to the managed nodes. -Firstly: Add your public SSH keys to the `authorized_keys` file on each remote system -Secondly: -Test the SSH connections: -`ssh username@192.0.2.50` +The next step we're going to set up is the SSH connection so Ansible can connect to the managed nodes. Add your public SSH keys to the `authorized_keys` file on each remote system and ensure you can't successfully connect. -In order to use the role, we will create the playbook file named `playbook.yml` for example: +In order to use the role, we will create the playbook file named `playbook.yml` for example : ```yaml --- - hosts: all become: true - roles: - bunkerweb ``` -Run the playbook: +Run the playbook : `ansible-playbook -i inventory.yml playbook.yml` -The configurations by default for Bunkerweb are minimals, so check out the rest of the documentations to configure Bunkerweb as you desire [quickstart-guide](http://localhost:8000/quickstart-guide/). \ No newline at end of file +The configurations by default for Bunkerweb are minimals, so check out the rest of the documentations to configure BunkerWeb as you desire [quickstart-guide](http://localhost:8000/quickstart-guide/). \ No newline at end of file