Reorganize Get Started Documentation Structure (#490)
@@ -140,6 +140,62 @@ const nextConfig = {
|
|||||||
destination: '/manage/access-control/endpoint-detection-and-response/intune-mdm',
|
destination: '/manage/access-control/endpoint-detection-and-response/intune-mdm',
|
||||||
permanent: true,
|
permanent: true,
|
||||||
},
|
},
|
||||||
|
// documentation redirects for get-started
|
||||||
|
{
|
||||||
|
source: '/how-to/getting-started',
|
||||||
|
destination: '/get-started',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation',
|
||||||
|
destination: '/get-started/install',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/linux',
|
||||||
|
destination: '/get-started/install/linux',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/windows',
|
||||||
|
destination: '/get-started/install/windows',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/macos',
|
||||||
|
destination: '/get-started/install/macos',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/docker',
|
||||||
|
destination: '/get-started/install/docker',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/synology',
|
||||||
|
destination: '/get-started/install/synology',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/mobile',
|
||||||
|
destination: '/get-started/install/mobile',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/pfsense',
|
||||||
|
destination: '/get-started/install/pfsense',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/installation/opnsense',
|
||||||
|
destination: '/get-started/install/opnsense',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
source: '/how-to/cli',
|
||||||
|
destination: '/get-started/cli',
|
||||||
|
permanent: true,
|
||||||
|
},
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
rewrites: async () => {
|
rewrites: async () => {
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 151 KiB After Width: | Height: | Size: 151 KiB |
|
Before Width: | Height: | Size: 215 KiB After Width: | Height: | Size: 215 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 284 KiB After Width: | Height: | Size: 284 KiB |
|
Before Width: | Height: | Size: 238 KiB After Width: | Height: | Size: 238 KiB |
|
Before Width: | Height: | Size: 486 KiB After Width: | Height: | Size: 486 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
@@ -0,0 +1,46 @@
|
|||||||
|
<svg id="livetype" xmlns="http://www.w3.org/2000/svg" width="119.66407" height="40" viewBox="0 0 119.66407 40">
|
||||||
|
<title>Download_on_the_App_Store_Badge_US-UK_RGB_blk_4SVG_092917</title>
|
||||||
|
<g>
|
||||||
|
<g>
|
||||||
|
<g>
|
||||||
|
<path d="M110.13477,0H9.53468c-.3667,0-.729,0-1.09473.002-.30615.002-.60986.00781-.91895.0127A13.21476,13.21476,0,0,0,5.5171.19141a6.66509,6.66509,0,0,0-1.90088.627A6.43779,6.43779,0,0,0,1.99757,1.99707,6.25844,6.25844,0,0,0,.81935,3.61816a6.60119,6.60119,0,0,0-.625,1.90332,12.993,12.993,0,0,0-.1792,2.002C.00587,7.83008.00489,8.1377,0,8.44434V31.5586c.00489.3105.00587.6113.01515.9219a12.99232,12.99232,0,0,0,.1792,2.0019,6.58756,6.58756,0,0,0,.625,1.9043A6.20778,6.20778,0,0,0,1.99757,38.001a6.27445,6.27445,0,0,0,1.61865,1.1787,6.70082,6.70082,0,0,0,1.90088.6308,13.45514,13.45514,0,0,0,2.0039.1768c.30909.0068.6128.0107.91895.0107C8.80567,40,9.168,40,9.53468,40H110.13477c.3594,0,.7246,0,1.084-.002.3047,0,.6172-.0039.9219-.0107a13.279,13.279,0,0,0,2-.1768,6.80432,6.80432,0,0,0,1.9082-.6308,6.27742,6.27742,0,0,0,1.6172-1.1787,6.39482,6.39482,0,0,0,1.1816-1.6143,6.60413,6.60413,0,0,0,.6191-1.9043,13.50643,13.50643,0,0,0,.1856-2.0019c.0039-.3106.0039-.6114.0039-.9219.0078-.3633.0078-.7246.0078-1.0938V9.53613c0-.36621,0-.72949-.0078-1.09179,0-.30664,0-.61426-.0039-.9209a13.5071,13.5071,0,0,0-.1856-2.002,6.6177,6.6177,0,0,0-.6191-1.90332,6.46619,6.46619,0,0,0-2.7988-2.7998,6.76754,6.76754,0,0,0-1.9082-.627,13.04394,13.04394,0,0,0-2-.17676c-.3047-.00488-.6172-.01074-.9219-.01269-.3594-.002-.7246-.002-1.084-.002Z" style="fill: #a6a6a6"/>
|
||||||
|
<path d="M8.44483,39.125c-.30468,0-.602-.0039-.90429-.0107a12.68714,12.68714,0,0,1-1.86914-.1631,5.88381,5.88381,0,0,1-1.65674-.5479,5.40573,5.40573,0,0,1-1.397-1.0166,5.32082,5.32082,0,0,1-1.02051-1.3965,5.72186,5.72186,0,0,1-.543-1.6572,12.41351,12.41351,0,0,1-.1665-1.875c-.00634-.2109-.01464-.9131-.01464-.9131V8.44434S.88185,7.75293.8877,7.5498a12.37039,12.37039,0,0,1,.16553-1.87207,5.7555,5.7555,0,0,1,.54346-1.6621A5.37349,5.37349,0,0,1,2.61183,2.61768,5.56543,5.56543,0,0,1,4.01417,1.59521a5.82309,5.82309,0,0,1,1.65332-.54394A12.58589,12.58589,0,0,1,7.543.88721L8.44532.875H111.21387l.9131.0127a12.38493,12.38493,0,0,1,1.8584.16259,5.93833,5.93833,0,0,1,1.6709.54785,5.59374,5.59374,0,0,1,2.415,2.41993,5.76267,5.76267,0,0,1,.5352,1.64892,12.995,12.995,0,0,1,.1738,1.88721c.0029.2832.0029.5874.0029.89014.0079.375.0079.73193.0079,1.09179V30.4648c0,.3633,0,.7178-.0079,1.0752,0,.3252,0,.6231-.0039.9297a12.73126,12.73126,0,0,1-.1709,1.8535,5.739,5.739,0,0,1-.54,1.67,5.48029,5.48029,0,0,1-1.0156,1.3857,5.4129,5.4129,0,0,1-1.3994,1.0225,5.86168,5.86168,0,0,1-1.668.5498,12.54218,12.54218,0,0,1-1.8692.1631c-.2929.0068-.5996.0107-.8974.0107l-1.084.002Z"/>
|
||||||
|
</g>
|
||||||
|
<g id="_Group_" data-name="<Group>">
|
||||||
|
<g id="_Group_2" data-name="<Group>">
|
||||||
|
<g id="_Group_3" data-name="<Group>">
|
||||||
|
<path id="_Path_" data-name="<Path>" d="M24.76888,20.30068a4.94881,4.94881,0,0,1,2.35656-4.15206,5.06566,5.06566,0,0,0-3.99116-2.15768c-1.67924-.17626-3.30719,1.00483-4.1629,1.00483-.87227,0-2.18977-.98733-3.6085-.95814a5.31529,5.31529,0,0,0-4.47292,2.72787c-1.934,3.34842-.49141,8.26947,1.3612,10.97608.9269,1.32535,2.01018,2.8058,3.42763,2.7533,1.38706-.05753,1.9051-.88448,3.5794-.88448,1.65876,0,2.14479.88448,3.591.8511,1.48838-.02416,2.42613-1.33124,3.32051-2.66914a10.962,10.962,0,0,0,1.51842-3.09251A4.78205,4.78205,0,0,1,24.76888,20.30068Z" style="fill: #fff"/>
|
||||||
|
<path id="_Path_2" data-name="<Path>" d="M22.03725,12.21089a4.87248,4.87248,0,0,0,1.11452-3.49062,4.95746,4.95746,0,0,0-3.20758,1.65961,4.63634,4.63634,0,0,0-1.14371,3.36139A4.09905,4.09905,0,0,0,22.03725,12.21089Z" style="fill: #fff"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
<g>
|
||||||
|
<path d="M42.30227,27.13965h-4.7334l-1.13672,3.35645H34.42727l4.4834-12.418h2.083l4.4834,12.418H43.438ZM38.0591,25.59082h3.752l-1.84961-5.44727h-.05176Z" style="fill: #fff"/>
|
||||||
|
<path d="M55.15969,25.96973c0,2.81348-1.50586,4.62109-3.77832,4.62109a3.0693,3.0693,0,0,1-2.84863-1.584h-.043v4.48438h-1.8584V21.44238H48.4302v1.50586h.03418a3.21162,3.21162,0,0,1,2.88281-1.60059C53.645,21.34766,55.15969,23.16406,55.15969,25.96973Zm-1.91016,0c0-1.833-.94727-3.03809-2.39258-3.03809-1.41992,0-2.375,1.23047-2.375,3.03809,0,1.82422.95508,3.0459,2.375,3.0459C52.30227,29.01563,53.24953,27.81934,53.24953,25.96973Z" style="fill: #fff"/>
|
||||||
|
<path d="M65.12453,25.96973c0,2.81348-1.50586,4.62109-3.77832,4.62109a3.0693,3.0693,0,0,1-2.84863-1.584h-.043v4.48438h-1.8584V21.44238H58.395v1.50586h.03418A3.21162,3.21162,0,0,1,61.312,21.34766C63.60988,21.34766,65.12453,23.16406,65.12453,25.96973Zm-1.91016,0c0-1.833-.94727-3.03809-2.39258-3.03809-1.41992,0-2.375,1.23047-2.375,3.03809,0,1.82422.95508,3.0459,2.375,3.0459C62.26711,29.01563,63.21438,27.81934,63.21438,25.96973Z" style="fill: #fff"/>
|
||||||
|
<path d="M71.71047,27.03613c.1377,1.23145,1.334,2.04,2.96875,2.04,1.56641,0,2.69336-.80859,2.69336-1.91895,0-.96387-.67969-1.541-2.28906-1.93652l-1.60937-.3877c-2.28027-.55078-3.33887-1.61719-3.33887-3.34766,0-2.14258,1.86719-3.61426,4.51855-3.61426,2.624,0,4.42285,1.47168,4.4834,3.61426h-1.876c-.1123-1.23926-1.13672-1.9873-2.63379-1.9873s-2.52148.75684-2.52148,1.8584c0,.87793.6543,1.39453,2.25488,1.79l1.36816.33594c2.54785.60254,3.60645,1.626,3.60645,3.44238,0,2.32324-1.85059,3.77832-4.79395,3.77832-2.75391,0-4.61328-1.4209-4.7334-3.667Z" style="fill: #fff"/>
|
||||||
|
<path d="M83.34621,19.2998v2.14258h1.72168v1.47168H83.34621v4.99121c0,.77539.34473,1.13672,1.10156,1.13672a5.80752,5.80752,0,0,0,.61133-.043v1.46289a5.10351,5.10351,0,0,1-1.03223.08594c-1.833,0-2.54785-.68848-2.54785-2.44434V22.91406H80.16262V21.44238H81.479V19.2998Z" style="fill: #fff"/>
|
||||||
|
<path d="M86.065,25.96973c0-2.84863,1.67773-4.63867,4.29395-4.63867,2.625,0,4.29492,1.79,4.29492,4.63867,0,2.85645-1.66113,4.63867-4.29492,4.63867C87.72609,30.6084,86.065,28.82617,86.065,25.96973Zm6.69531,0c0-1.9541-.89551-3.10742-2.40137-3.10742s-2.40039,1.16211-2.40039,3.10742c0,1.96191.89453,3.10645,2.40039,3.10645S92.76027,27.93164,92.76027,25.96973Z" style="fill: #fff"/>
|
||||||
|
<path d="M96.18606,21.44238h1.77246v1.541h.043a2.1594,2.1594,0,0,1,2.17773-1.63574,2.86616,2.86616,0,0,1,.63672.06934v1.73828a2.59794,2.59794,0,0,0-.835-.1123,1.87264,1.87264,0,0,0-1.93652,2.083v5.37012h-1.8584Z" style="fill: #fff"/>
|
||||||
|
<path d="M109.3843,27.83691c-.25,1.64355-1.85059,2.77148-3.89844,2.77148-2.63379,0-4.26855-1.76465-4.26855-4.5957,0-2.83984,1.64355-4.68164,4.19043-4.68164,2.50488,0,4.08008,1.7207,4.08008,4.46582v.63672h-6.39453v.1123a2.358,2.358,0,0,0,2.43555,2.56445,2.04834,2.04834,0,0,0,2.09082-1.27344Zm-6.28223-2.70215h4.52637a2.1773,2.1773,0,0,0-2.2207-2.29785A2.292,2.292,0,0,0,103.10207,25.13477Z" style="fill: #fff"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
<g id="_Group_4" data-name="<Group>">
|
||||||
|
<g>
|
||||||
|
<path d="M37.82619,8.731a2.63964,2.63964,0,0,1,2.80762,2.96484c0,1.90625-1.03027,3.002-2.80762,3.002H35.67092V8.731Zm-1.22852,5.123h1.125a1.87588,1.87588,0,0,0,1.96777-2.146,1.881,1.881,0,0,0-1.96777-2.13379h-1.125Z" style="fill: #fff"/>
|
||||||
|
<path d="M41.68068,12.44434a2.13323,2.13323,0,1,1,4.24707,0,2.13358,2.13358,0,1,1-4.24707,0Zm3.333,0c0-.97607-.43848-1.54687-1.208-1.54687-.77246,0-1.207.5708-1.207,1.54688,0,.98389.43457,1.55029,1.207,1.55029C44.57522,13.99463,45.01369,13.42432,45.01369,12.44434Z" style="fill: #fff"/>
|
||||||
|
<path d="M51.57326,14.69775h-.92187l-.93066-3.31641h-.07031l-.92676,3.31641h-.91309l-1.24121-4.50293h.90137l.80664,3.436h.06641l.92578-3.436h.85254l.92578,3.436h.07031l.80273-3.436h.88867Z" style="fill: #fff"/>
|
||||||
|
<path d="M53.85354,10.19482H54.709v.71533h.06641a1.348,1.348,0,0,1,1.34375-.80225,1.46456,1.46456,0,0,1,1.55859,1.6748v2.915h-.88867V12.00586c0-.72363-.31445-1.0835-.97168-1.0835a1.03294,1.03294,0,0,0-1.0752,1.14111v2.63428h-.88867Z" style="fill: #fff"/>
|
||||||
|
<path d="M59.09377,8.437h.88867v6.26074h-.88867Z" style="fill: #fff"/>
|
||||||
|
<path d="M61.21779,12.44434a2.13346,2.13346,0,1,1,4.24756,0,2.1338,2.1338,0,1,1-4.24756,0Zm3.333,0c0-.97607-.43848-1.54687-1.208-1.54687-.77246,0-1.207.5708-1.207,1.54688,0,.98389.43457,1.55029,1.207,1.55029C64.11232,13.99463,64.5508,13.42432,64.5508,12.44434Z" style="fill: #fff"/>
|
||||||
|
<path d="M66.4009,13.42432c0-.81055.60352-1.27783,1.6748-1.34424l1.21973-.07031v-.38867c0-.47559-.31445-.74414-.92187-.74414-.49609,0-.83984.18213-.93848.50049h-.86035c.09082-.77344.81836-1.26953,1.83984-1.26953,1.12891,0,1.76563.562,1.76563,1.51318v3.07666h-.85547v-.63281h-.07031a1.515,1.515,0,0,1-1.35254.707A1.36026,1.36026,0,0,1,66.4009,13.42432Zm2.89453-.38477v-.37646l-1.09961.07031c-.62012.0415-.90137.25244-.90137.64941,0,.40527.35156.64111.835.64111A1.0615,1.0615,0,0,0,69.29543,13.03955Z" style="fill: #fff"/>
|
||||||
|
<path d="M71.34816,12.44434c0-1.42285.73145-2.32422,1.86914-2.32422a1.484,1.484,0,0,1,1.38086.79h.06641V8.437h.88867v6.26074h-.85156v-.71143h-.07031a1.56284,1.56284,0,0,1-1.41406.78564C72.0718,14.772,71.34816,13.87061,71.34816,12.44434Zm.918,0c0,.95508.4502,1.52979,1.20313,1.52979.749,0,1.21191-.583,1.21191-1.52588,0-.93848-.46777-1.52979-1.21191-1.52979C72.72121,10.91846,72.26613,11.49707,72.26613,12.44434Z" style="fill: #fff"/>
|
||||||
|
<path d="M79.23,12.44434a2.13323,2.13323,0,1,1,4.24707,0,2.13358,2.13358,0,1,1-4.24707,0Zm3.333,0c0-.97607-.43848-1.54687-1.208-1.54687-.77246,0-1.207.5708-1.207,1.54688,0,.98389.43457,1.55029,1.207,1.55029C82.12453,13.99463,82.563,13.42432,82.563,12.44434Z" style="fill: #fff"/>
|
||||||
|
<path d="M84.66945,10.19482h.85547v.71533h.06641a1.348,1.348,0,0,1,1.34375-.80225,1.46456,1.46456,0,0,1,1.55859,1.6748v2.915H87.605V12.00586c0-.72363-.31445-1.0835-.97168-1.0835a1.03294,1.03294,0,0,0-1.0752,1.14111v2.63428h-.88867Z" style="fill: #fff"/>
|
||||||
|
<path d="M93.51516,9.07373v1.1416h.97559v.74854h-.97559V13.2793c0,.47168.19434.67822.63672.67822a2.96657,2.96657,0,0,0,.33887-.02051v.74023a2.9155,2.9155,0,0,1-.4834.04541c-.98828,0-1.38184-.34766-1.38184-1.21582v-2.543h-.71484v-.74854h.71484V9.07373Z" style="fill: #fff"/>
|
||||||
|
<path d="M95.70461,8.437h.88086v2.48145h.07031a1.3856,1.3856,0,0,1,1.373-.80664,1.48339,1.48339,0,0,1,1.55078,1.67871v2.90723H98.69v-2.688c0-.71924-.335-1.0835-.96289-1.0835a1.05194,1.05194,0,0,0-1.13379,1.1416v2.62988h-.88867Z" style="fill: #fff"/>
|
||||||
|
<path d="M104.76125,13.48193a1.828,1.828,0,0,1-1.95117,1.30273A2.04531,2.04531,0,0,1,100.73,12.46045a2.07685,2.07685,0,0,1,2.07617-2.35254c1.25293,0,2.00879.856,2.00879,2.27V12.688h-3.17969v.0498a1.1902,1.1902,0,0,0,1.19922,1.29,1.07934,1.07934,0,0,0,1.07129-.5459Zm-3.126-1.45117h2.27441a1.08647,1.08647,0,0,0-1.1084-1.1665A1.15162,1.15162,0,0,0,101.63527,12.03076Z" style="fill: #fff"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 11 KiB |
BIN
public/docs-static/img/get-started/mobile/google-play-badge.png
Normal file
|
After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 386 KiB After Width: | Height: | Size: 386 KiB |
|
Before Width: | Height: | Size: 327 KiB After Width: | Height: | Size: 327 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 130 KiB After Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 115 KiB After Width: | Height: | Size: 115 KiB |
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 121 KiB |
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 144 KiB After Width: | Height: | Size: 144 KiB |
|
Before Width: | Height: | Size: 84 KiB After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
|
Before Width: | Height: | Size: 202 KiB After Width: | Height: | Size: 202 KiB |
|
Before Width: | Height: | Size: 409 KiB After Width: | Height: | Size: 409 KiB |
|
Before Width: | Height: | Size: 526 KiB After Width: | Height: | Size: 526 KiB |
|
Before Width: | Height: | Size: 5.9 MiB After Width: | Height: | Size: 5.9 MiB |
|
Before Width: | Height: | Size: 321 KiB After Width: | Height: | Size: 321 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 184 KiB After Width: | Height: | Size: 184 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 449 KiB After Width: | Height: | Size: 449 KiB |
|
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 194 KiB After Width: | Height: | Size: 194 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 780 KiB After Width: | Height: | Size: 780 KiB |
@@ -30,21 +30,21 @@ export const docsNavigation = [
|
|||||||
{
|
{
|
||||||
title: 'GET STARTED',
|
title: 'GET STARTED',
|
||||||
links: [
|
links: [
|
||||||
{ title: 'Quickstart Guide', href: '/how-to/getting-started' },
|
{ title: 'Quickstart Guide', href: '/get-started' },
|
||||||
{
|
{
|
||||||
title: 'Install NetBird', isOpen: true, href: '/how-to/installation',
|
title: 'Install NetBird', isOpen: true, href: '/get-started/install',
|
||||||
links: [
|
links: [
|
||||||
{ title: 'Linux', href: '/how-to/installation/linux' },
|
{ title: 'Linux', href: '/get-started/install/linux' },
|
||||||
{ title: 'Windows', href: '/how-to/installation/windows' },
|
{ title: 'Windows', href: '/get-started/install/windows' },
|
||||||
{ title: 'MacOS', href: '/how-to/installation/macos' },
|
{ title: 'MacOS', href: '/get-started/install/macos' },
|
||||||
{ title: 'Docker', href: '/how-to/installation/docker' },
|
{ title: 'Docker', href: '/get-started/install/docker' },
|
||||||
{ title: 'Synology', href: '/how-to/installation/synology' },
|
{ title: 'Synology', href: '/get-started/install/synology' },
|
||||||
{ title: 'Android/iOS', href: '/how-to/installation/mobile' },
|
{ title: 'Android/iOS', href: '/get-started/install/mobile' },
|
||||||
{ title: 'pfSense', href: '/how-to/installation/pfsense' },
|
{ title: 'pfSense', href: '/get-started/install/pfsense' },
|
||||||
{ title: 'OPNsense', href: '/how-to/installation/opnsense' },
|
{ title: 'OPNsense', href: '/get-started/install/opnsense' },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{ title: 'CLI', href: '/how-to/cli' },
|
{ title: 'CLI', href: '/get-started/cli' },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ and build a secure peer-to-peer overlay network in less than ten minutes.
|
|||||||
|
|
||||||
First, let's create your NetBird account.
|
First, let's create your NetBird account.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. Navigate to [netbird.io](https://netbird.io/) and click Get Started in the top-right corner. Or simply click [here](https://app.netbird.io/).
|
1. Navigate to [netbird.io](https://netbird.io/) and click Get Started in the top-right corner. Or simply click [here](https://app.netbird.io/).
|
||||||
2. You’ll be redirected to the sign-in page, where NetBird uses your identity provider (IdP) for secure authentication.
|
2. You’ll be redirected to the sign-in page, where NetBird uses your identity provider (IdP) for secure authentication.
|
||||||
@@ -27,14 +27,14 @@ Upon your first login, you'll be greeted by a short onboarding survey. This help
|
|||||||
|
|
||||||
## Peer-to-Peer Network
|
## Peer-to-Peer Network
|
||||||
One way of using NetBird is to create a peer-to-peer network, where you run the NetBird client on your devices to connect them directly.
|
One way of using NetBird is to create a peer-to-peer network, where you run the NetBird client on your devices to connect them directly.
|
||||||

|

|
||||||
|
|
||||||
The onboarding process will now guide you to connect your first device, also known as a peer.
|
The onboarding process will now guide you to connect your first device, also known as a peer.
|
||||||
For this guide, we'll select Peer-to-Peer Network. If you’re selecting the Remote Network Access option, you can see that process [here](#remote-network-access).
|
For this guide, we'll select Peer-to-Peer Network. If you’re selecting the Remote Network Access option, you can see that process [here](#remote-network-access).
|
||||||
|
|
||||||
### Install Your First Peer
|
### Install Your First Peer
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. On the "Let's get your first device online" screen, click the Install NetBird button.
|
1. On the "Let's get your first device online" screen, click the Install NetBird button.
|
||||||
2. An [installation modal](https://app.netbird.io/install) will appear. Select your operating system (e.g., macOS, Windows, Linux). For this example, we're installing it on a macOS machine.
|
2. An [installation modal](https://app.netbird.io/install) will appear. Select your operating system (e.g., macOS, Windows, Linux). For this example, we're installing it on a macOS machine.
|
||||||
@@ -43,7 +43,7 @@ For this guide, we'll select Peer-to-Peer Network. If you’re selecting the Rem
|
|||||||
### Connect Your First Peer
|
### Connect Your First Peer
|
||||||
With the client installed, you now need to connect it to your network.
|
With the client installed, you now need to connect it to your network.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. After installation, find the NetBird icon in your system tray or menu bar.
|
1. After installation, find the NetBird icon in your system tray or menu bar.
|
||||||
2. Click the icon and select **Connect**.
|
2. Click the icon and select **Connect**.
|
||||||
@@ -53,14 +53,14 @@ With the client installed, you now need to connect it to your network.
|
|||||||
### Add a Second Peer (Headless Linux Server)
|
### Add a Second Peer (Headless Linux Server)
|
||||||
Next, let's add a second, headless peer, like a Linux server or a Raspberry Pi. For devices without a graphical interface, we use a [Setup Key](https://docs.netbird.io/how-to/register-machines-using-setup-keys).
|
Next, let's add a second, headless peer, like a Linux server or a Raspberry Pi. For devices without a graphical interface, we use a [Setup Key](https://docs.netbird.io/how-to/register-machines-using-setup-keys).
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. In the web UI, the onboarding flow will now prompt you to "bring in your second device." Click the link that says Install with a setup key.
|
1. In the web UI, the onboarding flow will now prompt you to "bring in your second device." Click the link that says Install with a setup key.
|
||||||
2. A pop-up will explain that a one-off setup key will be created, which you can also learn more about here. Click Continue..
|
2. A pop-up will explain that a one-off setup key will be created, which you can also learn more about here. Click Continue..
|
||||||
3. The onboarding UI will now provide two commands to run on your Linux server:
|
3. The onboarding UI will now provide two commands to run on your Linux server:
|
||||||
|
|
||||||
* **Install NetBird**: A curl command to download and run the installation script.
|
* **Install NetBird**: A curl command to download and run the installation script.
|
||||||
* **Run NetBird**: A [netbird up command](https://docs.netbird.io/how-to/cli) that includes your unique setup key.
|
* **Run NetBird**: A [netbird up command](https://docs.netbird.io/get-started/cli) that includes your unique setup key.
|
||||||
|
|
||||||
4. SSH into your Linux server and run the commands:
|
4. SSH into your Linux server and run the commands:
|
||||||
|
|
||||||
@@ -78,12 +78,12 @@ netbird up --setup-key <YOUR_SETUP_KEY>
|
|||||||
|
|
||||||
After running the second command, the terminal will confirm Connected. Your headless device is now part of your NetBird network.
|
After running the second command, the terminal will confirm Connected. Your headless device is now part of your NetBird network.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Verify the Connection
|
### Verify the Connection
|
||||||
The onboarding UI will now display both of your connected peers. The onboarding wizard provides a simple way to test that they can communicate directly.
|
The onboarding UI will now display both of your connected peers. The onboarding wizard provides a simple way to test that they can communicate directly.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. Copy the provided ping command from the onboarding UI. This command uses the NetBird IP address of your second peer (the Ubuntu server).
|
1. Copy the provided ping command from the onboarding UI. This command uses the NetBird IP address of your second peer (the Ubuntu server).
|
||||||
2. Open a terminal on your first peer and paste the command. Replace the example below with the NetBird IP for your machine.
|
2. Open a terminal on your first peer and paste the command. Replace the example below with the NetBird IP for your machine.
|
||||||
@@ -97,13 +97,13 @@ ping 100.74.76.17
|
|||||||
### Understanding Access Control
|
### Understanding Access Control
|
||||||
The final onboarding step introduces NetBird's powerful Access Control policies.
|
The final onboarding step introduces NetBird's powerful Access Control policies.
|
||||||
|
|
||||||

|

|
||||||
1. By default, a policy is active that allows connections between all your devices. This is why the ping command in the previous step worked.
|
1. By default, a policy is active that allows connections between all your devices. This is why the ping command in the previous step worked.
|
||||||
2. The wizard demonstrates this by allowing you to toggle the policy. If you disable the "Default Policy," the ping between your devices will immediately fail with a "Request timeout" error.
|
2. The wizard demonstrates this by allowing you to toggle the policy. If you disable the "Default Policy," the ping between your devices will immediately fail with a "Request timeout" error.
|
||||||
3. Re-enabling the policy instantly restores the connection. This gives you a basic understanding of how you can control traffic within your network. You can learn much more about policies [here](/manage/access-control/manage-network-access).
|
3. Re-enabling the policy instantly restores the connection. This gives you a basic understanding of how you can control traffic within your network. You can learn much more about policies [here](/manage/access-control/manage-network-access).
|
||||||
4. Click Continue to finish.
|
4. Click Continue to finish.
|
||||||
|
|
||||||

|

|
||||||
In the policy example above, we allowed _IT Admins_ port specific access to peers under the _AWS Servers_ group. Policies are a key building block to access in NetBird. You can learn more about the power of policies [here](https://docs.netbird.io/manage/access-control/manage-network-access).
|
In the policy example above, we allowed _IT Admins_ port specific access to peers under the _AWS Servers_ group. Policies are a key building block to access in NetBird. You can learn more about the power of policies [here](https://docs.netbird.io/manage/access-control/manage-network-access).
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
@@ -117,7 +117,7 @@ This machine acts as a routing peer, routing traffic to internal resources that
|
|||||||
The onboarding process will now guide you to build our first network resource.
|
The onboarding process will now guide you to build our first network resource.
|
||||||
For this guide, we'll select Remote Network Access.
|
For this guide, we'll select Remote Network Access.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Define Your Network Resource
|
### Define Your Network Resource
|
||||||
Next, you'll define the private network you want your users to be able to access.
|
Next, you'll define the private network you want your users to be able to access.
|
||||||
@@ -125,12 +125,12 @@ Next, you'll define the private network you want your users to be able to access
|
|||||||
2. Enter the CIDR range of your private network. For example, `10.0.0.0/32`.
|
2. Enter the CIDR range of your private network. For example, `10.0.0.0/32`.
|
||||||
3. Click Create Resource. A "Network" will be created in your dashboard to contain this resource and its access rules.
|
3. Click Create Resource. A "Network" will be created in your dashboard to contain this resource and its access rules.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Add and Configure a Routing Peer
|
### Add and Configure a Routing Peer
|
||||||
A [routing peer](https://docs.netbird.io/how-to/routing-traffic-to-private-networks) is a NetBird peer that lives inside your private network and acts as a gateway, forwarding traffic between your remote users and the internal resources.
|
A [routing peer](https://docs.netbird.io/how-to/routing-traffic-to-private-networks) is a NetBird peer that lives inside your private network and acts as a gateway, forwarding traffic between your remote users and the internal resources.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. The dashboard will now prompt you to "Add a routing peer." First, click Generate Setup Key. This creates a one-time key used to enroll the gateway machine into your NetBird account.
|
1. The dashboard will now prompt you to "Add a routing peer." First, click Generate Setup Key. This creates a one-time key used to enroll the gateway machine into your NetBird account.
|
||||||
2. Next, click Install Routing Peer. Select the operating system of your gateway machine (the video uses Linux).
|
2. Next, click Install Routing Peer. Select the operating system of your gateway machine (the video uses Linux).
|
||||||
@@ -160,7 +160,7 @@ Now, set up the device you will use to connect to your private network.
|
|||||||
### Test the Connection
|
### Test the Connection
|
||||||
With both the routing peer and your client device online, you can now test your connection to the private network. To properly test connectivity you should move the client device to a different network, for example, connecting the device using your phone's hotspot.
|
With both the routing peer and your client device online, you can now test your connection to the private network. To properly test connectivity you should move the client device to a different network, for example, connecting the device using your phone's hotspot.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. Open a terminal on your client device and run the test command (e.g., `ping 10.0.0.100`). Due note, the IP you ping needs to be a device on the same network that the routing peer is installed on.
|
1. Open a terminal on your client device and run the test command (e.g., `ping 10.0.0.100`). Due note, the IP you ping needs to be a device on the same network that the routing peer is installed on.
|
||||||
2. You should see successful replies, confirming that your client device can reach internal resources through the routing peer.
|
2. You should see successful replies, confirming that your client device can reach internal resources through the routing peer.
|
||||||
@@ -169,14 +169,14 @@ With both the routing peer and your client device online, you can now test your
|
|||||||
### Understanding Your Access Policy
|
### Understanding Your Access Policy
|
||||||
The final step of the onboarding wizard explains the access rule that was automatically created for you.
|
The final step of the onboarding wizard explains the access rule that was automatically created for you.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. A policy, named "Users to My Subnet," is enabled by default. This policy allows all authenticated users to access the resources within the subnet you define.
|
1. A policy, named "Users to My Subnet," is enabled by default. This policy allows all authenticated users to access the resources within the subnet you define.
|
||||||
2. To demonstrate this, you can toggle this policy off. When disabled, the ping from your client device will begin to fail with a "Request timeout" error, showing that the connection is now blocked.
|
2. To demonstrate this, you can toggle this policy off. When disabled, the ping from your client device will begin to fail with a "Request timeout" error, showing that the connection is now blocked.
|
||||||
3. Re-enabling the policy will immediately restore access.
|
3. Re-enabling the policy will immediately restore access.
|
||||||
4. Click Continue to complete the setup.
|
4. Click Continue to complete the setup.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Click Go to Dashboard to access the main NetBird admin panel. From here, you can:
|
Click Go to Dashboard to access the main NetBird admin panel. From here, you can:
|
||||||
|
|
||||||
@@ -9,7 +9,7 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
|
|||||||
Set the ```NB_SETUP_KEY``` environment variable and run the command.
|
Set the ```NB_SETUP_KEY``` environment variable and run the command.
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
You can pass other settings as environment variables. See [Environment variables](/how-to/cli#environment-variables) for details.
|
You can pass other settings as environment variables. See [Environment variables](/get-started/cli#environment-variables) for details.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
NetBird makes use of eBPF and raw sockets, therefore to guarantee the client software functionality, we recommend adding the flags `--cap-add=SYS_ADMIN` and `--cap-add=SYS_RESOURCE` for docker clients.
|
NetBird makes use of eBPF and raw sockets, therefore to guarantee the client software functionality, we recommend adding the flags `--cap-add=SYS_ADMIN` and `--cap-add=SYS_RESOURCE` for docker clients.
|
||||||
@@ -2,7 +2,7 @@ import {Note} from "@/components/mdx";
|
|||||||
|
|
||||||
# Install NetBird
|
# Install NetBird
|
||||||
|
|
||||||
If you're a new user you should visit the [Quickstart Guide](https://docs.netbird.io/how-to/getting-started). This will help you setup your management dashboard and connect your first client. For quick install instructions, including desktop applications, visit the [install prompt](https://app.netbird.io/install) through the management dashboard. To view all the client installation methods we've set up a variety of platform specific pages.
|
If you're a new user you should visit the [Quickstart Guide](https://docs.netbird.io/get-started). This will help you setup your management dashboard and connect your first client. For quick install instructions, including desktop applications, visit the [install prompt](https://app.netbird.io/install) through the management dashboard. To view all the client installation methods we've set up a variety of platform specific pages.
|
||||||
|
|
||||||
<Button href="https://app.netbird.io/install" arrow="right" children="Download NetBird" />
|
<Button href="https://app.netbird.io/install" arrow="right" children="Download NetBird" />
|
||||||
|
|
||||||
@@ -10,12 +10,12 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
|
|||||||
|
|
||||||
## Install and Update Instructions
|
## Install and Update Instructions
|
||||||
|
|
||||||
* [Install on Linux](/how-to/installation/linux)
|
* [Install on Linux](/get-started/install/linux)
|
||||||
* [Install on macOS](/how-to/installation/macos)
|
* [Install on macOS](/get-started/install/macos)
|
||||||
* [Install on Windows](/how-to/installation/windows)
|
* [Install on Windows](/get-started/install/windows)
|
||||||
* [Install on Synology](/how-to/installation/synology)
|
* [Install on Synology](/get-started/install/synology)
|
||||||
* [Install on Android](/how-to/installation/mobile)
|
* [Install on Android](/get-started/install/mobile)
|
||||||
* [Install on iOS](/how-to/installation/mobile)
|
* [Install on iOS](/get-started/install/mobile)
|
||||||
|
|
||||||
## Running NetBird with SSO Login
|
## Running NetBird with SSO Login
|
||||||
### Desktop UI Application
|
### Desktop UI Application
|
||||||
@@ -23,7 +23,7 @@ If you installed the Desktop UI client, you can launch it and click on Connect.
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
@@ -34,7 +34,7 @@ Alternatively, you could use command line. Simply run
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Check connection status:
|
Check connection status:
|
||||||
@@ -230,7 +230,7 @@ If you installed the Desktop UI client, you can launch it and click on Connect.
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
@@ -241,7 +241,7 @@ Alternatively, you could use command line. Simply run
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Check connection status:
|
Check connection status:
|
||||||
@@ -88,7 +88,7 @@ If you installed the Desktop UI client, you can launch it and click on Connect.
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
@@ -99,7 +99,7 @@ Alternatively, you could use command line. Simply run
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Check connection status:
|
Check connection status:
|
||||||
@@ -46,7 +46,7 @@ Fill out the authentication form with the following values and click `Save`:
|
|||||||
- **Setup Key**: Paste the setup key from your NetBird account.
|
- **Setup Key**: Paste the setup key from your NetBird account.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/opnsense/authentication.png" alt="authentication" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/opnsense/authentication.png" alt="authentication" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### Verify Connection Status
|
### Verify Connection Status
|
||||||
@@ -57,7 +57,7 @@ Access it via `VPN` > `NetBird` > `Status` in the OPNsense menu.
|
|||||||
Use this section for diagnostics and troubleshooting common connection or setup issues.
|
Use this section for diagnostics and troubleshooting common connection or setup issues.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/opnsense/status.png" alt="connection status" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/opnsense/status.png" alt="connection status" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### Assign NetBird interface
|
### Assign NetBird interface
|
||||||
@@ -67,12 +67,12 @@ After installation, a new interface named `wt0` will be available but unassigned
|
|||||||
- **Description**: `NetBird`
|
- **Description**: `NetBird`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/opnsense/interface_assignment.png" alt="interfaceAssignment" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/opnsense/interface_assignment.png" alt="interfaceAssignment" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Click `Add` to assign the interface.
|
Click `Add` to assign the interface.
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/opnsense/new_interface.png" alt="interfaceAssignment" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/opnsense/new_interface.png" alt="interfaceAssignment" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ the following options and click `Save`, then `Apply changes` to activate the int
|
|||||||
- **Enable**: `✓ Enable Interface`
|
- **Enable**: `✓ Enable Interface`
|
||||||
- **Lock**: `✓ Prevent interface removal`
|
- **Lock**: `✓ Prevent interface removal`
|
||||||
|
|
||||||
<p> <img src="/docs-static/img/how-to-guides/opnsense/enable_interface.png" alt="enableInterface" className="imagewrapper-big"/> </p>
|
<p> <img src="/docs-static/img/get-started/opnsense/enable_interface.png" alt="enableInterface" className="imagewrapper-big"/> </p>
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
OPNsense includes native WireGuard support, however do not configure or manage the NetBird interface (wt0) via the OPNsense WireGuard UI.
|
OPNsense includes native WireGuard support, however do not configure or manage the NetBird interface (wt0) via the OPNsense WireGuard UI.
|
||||||
@@ -108,7 +108,7 @@ This ensures traffic flows freely, while NetBird’s own policies (ACLs) govern
|
|||||||
5. Ensure this rule is at the top of the `NetBird` rules list so it isn’t shadowed by other rules.
|
5. Ensure this rule is at the top of the `NetBird` rules list so it isn’t shadowed by other rules.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/opnsense/firewall_rules.png" alt="firewallRules" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/opnsense/firewall_rules.png" alt="firewallRules" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Get started
|
## Get started
|
||||||
@@ -58,7 +58,7 @@ Fill out the authentication form with the following values and click `Save`:
|
|||||||
- **Setup Key**: Paste the setup key from your NetBird account. .
|
- **Setup Key**: Paste the setup key from your NetBird account. .
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/pfSense/authentication.png" alt="authentication" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/pfSense/authentication.png" alt="authentication" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### Verify Connection Status
|
### Verify Connection Status
|
||||||
@@ -69,7 +69,7 @@ Access it via `Status` > `NetBird` in the pfSense menu.
|
|||||||
Use this section for diagnostics and troubleshooting common connection or setup issues.
|
Use this section for diagnostics and troubleshooting common connection or setup issues.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/pfSense/status.png" alt="connection status" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/pfSense/status.png" alt="connection status" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### Assign NetBird interface
|
### Assign NetBird interface
|
||||||
@@ -77,7 +77,7 @@ After authentication, a new interface named `wt0(wt0)` will be available but una
|
|||||||
`Interfaces` > `Assignments`. Under `Available network ports`, select the NetBird interface `wt0(wt0)` and click `Add`.
|
`Interfaces` > `Assignments`. Under `Available network ports`, select the NetBird interface `wt0(wt0)` and click `Add`.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/how-to-guides/pfSense/new_interface.png" alt="NewInterface" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/pfSense/new_interface.png" alt="NewInterface" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### Enable the NetBird interface
|
### Enable the NetBird interface
|
||||||
@@ -88,7 +88,7 @@ the following options and click `Save`, then `Apply changes` to activate the int
|
|||||||
- **Enable**: `✓ Enable Interface`
|
- **Enable**: `✓ Enable Interface`
|
||||||
- **Description**: `NetBird`
|
- **Description**: `NetBird`
|
||||||
|
|
||||||
<p> <img src="/docs-static/img/how-to-guides/pfSense/enable_interface.png" alt="enableInterface" className="imagewrapper-big"/> </p>
|
<p> <img src="/docs-static/img/get-started/pfSense/enable_interface.png" alt="enableInterface" className="imagewrapper-big"/> </p>
|
||||||
|
|
||||||
### Configure Firewall Rules for the NetBird interface
|
### Configure Firewall Rules for the NetBird interface
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ Create rules to control traffic coming from your NetBird network into pfSense an
|
|||||||
- **Description**: `Allow all on NetBird (managed by NetBird)`
|
- **Description**: `Allow all on NetBird (managed by NetBird)`
|
||||||
3. Click `Save`, then `Apply Changes`
|
3. Click `Save`, then `Apply Changes`
|
||||||
|
|
||||||
<p><img src="/docs-static/img/how-to-guides/pfSense/firewall_rules.png" alt="firewallRules" className="imagewrapper-big"/></p>
|
<p><img src="/docs-static/img/get-started/pfSense/firewall_rules.png" alt="firewallRules" className="imagewrapper-big"/></p>
|
||||||
|
|
||||||
## Uninstallation
|
## Uninstallation
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ If you installed the Desktop UI client, you can launch it and click on Connect.
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
@@ -31,7 +31,7 @@ Alternatively, you could use command line. Simply run
|
|||||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Check connection status:
|
Check connection status:
|
||||||
@@ -16,7 +16,7 @@ local network resources through a routing peer using the [NetBird Networks featu
|
|||||||
NetBird comes with a Desktop UI application that can be found in the systray. If it hasn't automatically started, look for `NetBird` in the application list, run it, and click `Connect`:
|
NetBird comes with a Desktop UI application that can be found in the systray. If it hasn't automatically started, look for `NetBird` in the application list, run it, and click `Connect`:
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/getting-started/systray.png" alt="login-to-netbird" className="imagewrapper"/>
|
<img src="/docs-static/img/get-started/systray.png" alt="login-to-netbird" className="imagewrapper"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Let's dive into the process of using NetBird to manage network access in an auto
|
|||||||
To replicate this use case, you'll need:
|
To replicate this use case, you'll need:
|
||||||
|
|
||||||
* A [NetBird account](https://app.netbird.io/)
|
* A [NetBird account](https://app.netbird.io/)
|
||||||
* [NetBird](/how-to/installation) installed on your local machine
|
* [NetBird](/get-started/install) installed on your local machine
|
||||||
* A Kubernetes cluster (local or cloud-based)
|
* A Kubernetes cluster (local or cloud-based)
|
||||||
* `kubectl` installed and configured on your local machine
|
* `kubectl` installed and configured on your local machine
|
||||||
* [Kubernetes metrics server](https://github.com/kubernetes-sigs/metrics-server)
|
* [Kubernetes metrics server](https://github.com/kubernetes-sigs/metrics-server)
|
||||||
@@ -184,7 +184,11 @@ spec:
|
|||||||
cpu: 100m
|
cpu: 100m
|
||||||
memory: 128Mi
|
memory: 128Mi
|
||||||
securityContext:
|
securityContext:
|
||||||
privileged: true
|
capabilities:
|
||||||
|
add:
|
||||||
|
- NET_ADMIN
|
||||||
|
- SYS_RESOURCE
|
||||||
|
- SYS_ADMIN
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ In this scenario, an AI software company needs secure access to its internal dom
|
|||||||
|
|
||||||
To effectively access entire domains within your internal networks using NetBird, ensure the following pre-requisites are met:
|
To effectively access entire domains within your internal networks using NetBird, ensure the following pre-requisites are met:
|
||||||
|
|
||||||
- **NetBird Clients**: Install [NetBird clients](https://docs.netbird.io/how-to/getting-started) on all devices used by developers and data scientists. This is essential to establish secure connectivity to your internal resources.
|
- **NetBird Clients**: Install [NetBird clients](https://docs.netbird.io/get-started) on all devices used by developers and data scientists. This is essential to establish secure connectivity to your internal resources.
|
||||||
- **Routing Peers**: Configure [NetBird routing peers](https://docs.netbird.io/how-to/networks-concept#routing-peers) within your network infrastructure using [setup keys](https://docs.netbird.io/how-to/setup-keys-add-servers-to-network). Routing peers facilitate traffic routing across different network segments, ensuring seamless access to both internal domains.
|
- **Routing Peers**: Configure [NetBird routing peers](https://docs.netbird.io/how-to/networks-concept#routing-peers) within your network infrastructure using [setup keys](https://docs.netbird.io/how-to/setup-keys-add-servers-to-network). Routing peers facilitate traffic routing across different network segments, ensuring seamless access to both internal domains.
|
||||||
- **Nameserver Configuration**: Ensure that your Nameservers are properly configured within your NetBird account to resolve all domain queries. This step is critical for enabling seamless domain name resolution across your network, facilitating efficient connectivity to both your development and AI model training environments. For detailed instructions, refer to the [Manage DNS in Your Network](https://docs.netbird.io/how-to/manage-dns-in-your-network).
|
- **Nameserver Configuration**: Ensure that your Nameservers are properly configured within your NetBird account to resolve all domain queries. This step is critical for enabling seamless domain name resolution across your network, facilitating efficient connectivity to both your development and AI model training environments. For detailed instructions, refer to the [Manage DNS in Your Network](https://docs.netbird.io/how-to/manage-dns-in-your-network).
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ It is very common to find scenarios where you need to access restricted websites
|
|||||||
|
|
||||||
Imagine a company that runs its accounting application at the subdomain `accounting.example.com`. The website is behind a load balancer and hosted on an EC2 instance within the company's AWS infrastructure in the EU Central region. To enhance security, the company decided to follow zero-trust principles by giving differentiated access to the finance and support teams tailored to their specific responsibilities and operational needs.
|
Imagine a company that runs its accounting application at the subdomain `accounting.example.com`. The website is behind a load balancer and hosted on an EC2 instance within the company's AWS infrastructure in the EU Central region. To enhance security, the company decided to follow zero-trust principles by giving differentiated access to the finance and support teams tailored to their specific responsibilities and operational needs.
|
||||||
|
|
||||||
To this end, the company deployed [NetBird clients](https://docs.netbird.io/how-to/getting-started) on the devices used by both the finance and support teams. Complementing this, [NetBird routing peers](https://docs.netbird.io/how-to/networks-concept#routing-peers) were configured within the AWS VPC using [setup keys](https://docs.netbird.io/how-to/setup-keys-add-servers-to-network). This configuration guarantees a solid foundation for streamlined and secure connectivity.
|
To this end, the company deployed [NetBird clients](https://docs.netbird.io/get-started) on the devices used by both the finance and support teams. Complementing this, [NetBird routing peers](https://docs.netbird.io/how-to/networks-concept#routing-peers) were configured within the AWS VPC using [setup keys](https://docs.netbird.io/how-to/setup-keys-add-servers-to-network). This configuration guarantees a solid foundation for streamlined and secure connectivity.
|
||||||
|
|
||||||
More importantly, this setup allows the company to use NetBird's Networks and [Access Policies](https://docs.netbird.io/manage/access-control/manage-network-access), to ensure that only authorized finance and support team members access the restricted website domain as follows:
|
More importantly, this setup allows the company to use NetBird's Networks and [Access Policies](https://docs.netbird.io/manage/access-control/manage-network-access), to ensure that only authorized finance and support team members access the restricted website domain as follows:
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ In this hands-on tutorial, you'll learn how to use Acronis Cyber Protect Cloud s
|
|||||||
Before beginning this tutorial, ensure you have the following prerequisites in place:
|
Before beginning this tutorial, ensure you have the following prerequisites in place:
|
||||||
|
|
||||||
- A [NetBird account](https://app.netbird.io) with administrative permissions to create and manage access policies.
|
- A [NetBird account](https://app.netbird.io) with administrative permissions to create and manage access policies.
|
||||||
- NetBird's Windows installer (`exe` or `.msi`) downloaded from the [NetBird installation documentation](https://docs.netbird.io/how-to/installation#windows)
|
- NetBird's Windows installer (`exe` or `.msi`) downloaded from the [NetBird installation documentation](https://docs.netbird.io/get-started/install/windows)
|
||||||
- An active [Acronis Cyber Protect Cloud](https://www.acronis.com/en-us/products/cloud/cyber-protect/) subscription like [Cyber Protect Advanced](https://www.acronis.com/en-us/support/documentation/AcronisCyberProtect_15/index.html#editions-and-licensing.html).
|
- An active [Acronis Cyber Protect Cloud](https://www.acronis.com/en-us/products/cloud/cyber-protect/) subscription like [Cyber Protect Advanced](https://www.acronis.com/en-us/support/documentation/AcronisCyberProtect_15/index.html#editions-and-licensing.html).
|
||||||
- Acronis Cyber Protect Cloud Agent [installed and registered on all target Windows and macOS machines](https://www.acronis.com/en-us/support/documentation/AcronisCyberProtect_15/index.html#installation-overview.html).
|
- Acronis Cyber Protect Cloud Agent [installed and registered on all target Windows and macOS machines](https://www.acronis.com/en-us/support/documentation/AcronisCyberProtect_15/index.html#installation-overview.html).
|
||||||
- Administrative access to the Acronis Cyber Protect Cloud Console with [permissions to manage software deployment and device policies](https://www.acronis.com/en-us/support/documentation/AcronisCyberProtect_15/index.html#adding-administrators-acronis-account.html).
|
- Administrative access to the Acronis Cyber Protect Cloud Console with [permissions to manage software deployment and device policies](https://www.acronis.com/en-us/support/documentation/AcronisCyberProtect_15/index.html#adding-administrators-acronis-account.html).
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ This practical scenario illustrates how NetBird enables organizations to use clo
|
|||||||
To follow along with this use case, ensure you meet the following requisites:
|
To follow along with this use case, ensure you meet the following requisites:
|
||||||
|
|
||||||
* A [NetBird account](https://app.netbird.io/)
|
* A [NetBird account](https://app.netbird.io/)
|
||||||
* [NetBird installed](https://docs.netbird.io/how-to/installation) in your laptop or local machine.
|
* [NetBird installed](https://docs.netbird.io/get-started/install) in your laptop or local machine.
|
||||||
* A cloud-based VM instance (e.g., AWS EC2, Google Compute Engine, or Azure VM) to serve as the destination for the migrated workload.
|
* A cloud-based VM instance (e.g., AWS EC2, Google Compute Engine, or Azure VM) to serve as the destination for the migrated workload.
|
||||||
* Python 3.x installed on both source and destination instances.
|
* Python 3.x installed on both source and destination instances.
|
||||||
* Ability to create and use Python virtual environments on both instances (optional but recommended to avoid OS conflicts).
|
* Ability to create and use Python virtual environments on both instances (optional but recommended to avoid OS conflicts).
|
||||||
@@ -328,7 +328,7 @@ These changes allow PostgreSQL to listen on all interfaces and accept connection
|
|||||||
|
|
||||||
To complete the migration, deploy your workload to the remote instance by recreating the local setup: establish a Python virtual environment, install the `psycopg2-binary` library, and create `employee_workload.py`. However, in the Python code, you must update the `host` parameter, replacing `localhost` with the NetBird-assigned IP address of the remote instance. You can find this IP address in your peers' list on your NetBird dashboard.
|
To complete the migration, deploy your workload to the remote instance by recreating the local setup: establish a Python virtual environment, install the `psycopg2-binary` library, and create `employee_workload.py`. However, in the Python code, you must update the `host` parameter, replacing `localhost` with the NetBird-assigned IP address of the remote instance. You can find this IP address in your peers' list on your NetBird dashboard.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Optionally, you can change the label `(On-Premise)` with `(Remote)` as mentioned earlier. The Python code should look similar to this:
|
Optionally, you can change the label `(On-Premise)` with `(Remote)` as mentioned earlier. The Python code should look similar to this:
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ To ensure a high level of security, NetBird offers a peer login expiration featu
|
|||||||
Every new network has this feature enabled, and the expiration period is set to 24 hours by default. You can disable this feature and configure the expiration period in the account settings in the web UI https://app.netbird.io/settings.
|
Every new network has this feature enabled, and the expiration period is set to 24 hours by default. You can disable this feature and configure the expiration period in the account settings in the web UI https://app.netbird.io/settings.
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
This feature is only applied to peers added with the [interactive SSO login feature](/how-to/installation#running-net-bird-with-sso-login). Peers, added with a setup key, won't be affected.
|
This feature is only applied to peers added with the [interactive SSO login feature](/get-started/install#running-net-bird-with-sso-login). Peers, added with a setup key, won't be affected.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
Expired peers will appear in the peers' view with the status `Login required`.
|
Expired peers will appear in the peers' view with the status `Login required`.
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ Opt for Win32 app deployment over the Line-of-Business (LOB) method (described i
|
|||||||
Using the Win32 method requires you to convert either NetBird's `.exe` or `.msi` installer to the `.intunewin` format. Here's an overview of the procedure using the `.exe` installer:
|
Using the Win32 method requires you to convert either NetBird's `.exe` or `.msi` installer to the `.intunewin` format. Here's an overview of the procedure using the `.exe` installer:
|
||||||
|
|
||||||
- Download the Microsoft Win32 Content Prep Tool from [GitHub](https://github.com/Microsoft/Microsoft-Win32-Content-Prep-Tool)
|
- Download the Microsoft Win32 Content Prep Tool from [GitHub](https://github.com/Microsoft/Microsoft-Win32-Content-Prep-Tool)
|
||||||
- Download your preferred NetBird Windows installer from the [NetBird installation documentation](https://docs.netbird.io/how-to/installation#windows)
|
- Download your preferred NetBird Windows installer from the [NetBird installation documentation](https://docs.netbird.io/get-started/install/windows)
|
||||||
- Run the Content Prep Tool and follow the instructions to convert the NetBird installer to `.intunewin` format. You'll be asked about the source folder (usually where you downloaded the installer), the NetBird setup file you will use, and the output folder (where you want the `.intunewin` file to be saved).
|
- Run the Content Prep Tool and follow the instructions to convert the NetBird installer to `.intunewin` format. You'll be asked about the source folder (usually where you downloaded the installer), the NetBird setup file you will use, and the output folder (where you want the `.intunewin` file to be saved).
|
||||||
- For detailed information on using the Win32 Content Prep Tool, refer to [Microsoft's documentation](https://learn.microsoft.com/en-us/intune/intune-service/apps/apps-win32-prepare).
|
- For detailed information on using the Win32 Content Prep Tool, refer to [Microsoft's documentation](https://learn.microsoft.com/en-us/intune/intune-service/apps/apps-win32-prepare).
|
||||||
|
|
||||||
@@ -157,7 +157,7 @@ As a simpler alternative to the Win32 method described previously, you can deplo
|
|||||||
|
|
||||||
### Adding NetBird MSI Installer to Intune
|
### Adding NetBird MSI Installer to Intune
|
||||||
|
|
||||||
- Download the NetBird Windows MSI installer from the [NetBird installation documentation](https://docs.netbird.io/how-to/installation#windows)
|
- Download the NetBird Windows MSI installer from the [NetBird installation documentation](https://docs.netbird.io/get-started/install/windows)
|
||||||
- Sign in to the [Microsoft Intune admin center](https://intune.microsoft.com), navigate to `Apps`, and click the `Windows` button.
|
- Sign in to the [Microsoft Intune admin center](https://intune.microsoft.com), navigate to `Apps`, and click the `Windows` button.
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
@@ -24,7 +24,7 @@ To replicate this use case, you'll need the following prerequisites:
|
|||||||
|
|
||||||
* An main [NetBird account](https://app.netbird.io/) with administrative privileges.
|
* An main [NetBird account](https://app.netbird.io/) with administrative privileges.
|
||||||
* A secondary email address not linked to any NetBird account to simulate the freelancer's email.
|
* A secondary email address not linked to any NetBird account to simulate the freelancer's email.
|
||||||
* [NetBird installed](/how-to/installation) on the main device.
|
* [NetBird installed](/get-started/install) on the main device.
|
||||||
|
|
||||||
With these prerequisites in place, you're ready to simulate granting network access to a temporary remote worker using NetBird's Peer Approval feature by:
|
With these prerequisites in place, you're ready to simulate granting network access to a temporary remote worker using NetBird's Peer Approval feature by:
|
||||||
|
|
||||||
@@ -85,11 +85,11 @@ After clicking the invitation link, you'll be directed to NetBird's secure accou
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Upon logging in, you'll arrive at NetBird's Peers dashboard. Locate and click the `Add Peer` button to initiate the [Getting Started](/how-to/getting-started) Wizard, which guides you through the process of adding a new device to the network.
|
Upon logging in, you'll arrive at NetBird's Peers dashboard. Locate and click the `Add Peer` button to initiate the [Getting Started](/get-started) Wizard, which guides you through the process of adding a new device to the network.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
The wizard will detect your operating system and provide detailed step-by-step instructions on how to [install NetBird](/how-to/installation).
|
The wizard will detect your operating system and provide detailed step-by-step instructions on how to [install NetBird](/get-started/install).
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ For this use case, you'll need the following prerequisites:
|
|||||||
|
|
||||||
* A [NetBird account](https://app.netbird.io/)
|
* A [NetBird account](https://app.netbird.io/)
|
||||||
* Single Sign-On (SSO) authentication set up with your preferred identity provider (optional but recommended for enhanced security).
|
* Single Sign-On (SSO) authentication set up with your preferred identity provider (optional but recommended for enhanced security).
|
||||||
* [NetBird installed](/how-to/installation) on your local machine.
|
* [NetBird installed](/get-started/install) on your local machine.
|
||||||
* A virtual machine running your target web server, configured to accept incoming SSH connections.
|
* A virtual machine running your target web server, configured to accept incoming SSH connections.
|
||||||
|
|
||||||
With prerequisites in place, you'll be prepared to establish an encrypted point-to-point connection between your local machine and the remote web server by:
|
With prerequisites in place, you'll be prepared to establish an encrypted point-to-point connection between your local machine and the remote web server by:
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Let's dive into the step-by-step process of using [NetBird's Setup Keys](/how-to
|
|||||||
For this tutorial, you'll need the following prerequisites:
|
For this tutorial, you'll need the following prerequisites:
|
||||||
|
|
||||||
* A [NetBird account](https://app.netbird.io/)
|
* A [NetBird account](https://app.netbird.io/)
|
||||||
* The [NetBird agent](https://docs.netbird.io/how-to/installation) installed in your local machine
|
* The [NetBird agent](https://docs.netbird.io/get-started/install) installed in your local machine
|
||||||
* A cloud-hosted virtual machine (VM) with SSH access
|
* A cloud-hosted virtual machine (VM) with SSH access
|
||||||
* [Docker](https://www.docker.com/) installed on the cloud VM
|
* [Docker](https://www.docker.com/) installed on the cloud VM
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ ensuring a consistent integration process.
|
|||||||
After creating your setup key, the next step is to provision your VM and install NetBird:
|
After creating your setup key, the next step is to provision your VM and install NetBird:
|
||||||
|
|
||||||
* SSH into your cloud-hosted VM
|
* SSH into your cloud-hosted VM
|
||||||
* [Install NetBird](https://docs.netbird.io/how-to/installation) by running:
|
* [Install NetBird](https://docs.netbird.io/get-started/install) by running:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -fsSL https://pkgs.netbird.io/install.sh | sh
|
curl -fsSL https://pkgs.netbird.io/install.sh | sh
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ netbird ssh -L 8080:localhost:80 user@100.119.230.104
|
|||||||
netbird ssh -R 8080:localhost:3000 user@100.119.230.104
|
netbird ssh -R 8080:localhost:3000 user@100.119.230.104
|
||||||
```
|
```
|
||||||
|
|
||||||
For detailed CLI usage, see the [CLI documentation](/how-to/cli#ssh).
|
For detailed CLI usage, see the [CLI documentation](/get-started/cli#ssh).
|
||||||
|
|
||||||
### Native SSH Clients (OpenSSH)
|
### Native SSH Clients (OpenSSH)
|
||||||
|
|
||||||
@@ -474,7 +474,7 @@ SSH access is controlled by multiple layers:
|
|||||||
|
|
||||||
## CLI Reference
|
## CLI Reference
|
||||||
|
|
||||||
For complete CLI command reference, including all SSH-related commands and flags, see the [CLI documentation](/how-to/cli#ssh).
|
For complete CLI command reference, including all SSH-related commands and flags, see the [CLI documentation](/get-started/cli#ssh).
|
||||||
|
|
||||||
## Migrating from v0.59.x and Earlier
|
## Migrating from v0.59.x and Earlier
|
||||||
|
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ As for Peers, the status will show the following information:
|
|||||||
* `Transfer status (received/sent)`: Indicating the amount of data received and sent by the peer. This is useful to
|
* `Transfer status (received/sent)`: Indicating the amount of data received and sent by the peer. This is useful to
|
||||||
check if the connection is being used.
|
check if the connection is being used.
|
||||||
|
|
||||||
See more details about the status command [here](/how-to/cli#status).
|
See more details about the status command [here](/get-started/cli#status).
|
||||||
|
|
||||||
## Getting client logs
|
## Getting client logs
|
||||||
|
|
||||||
|
|||||||
@@ -65,9 +65,6 @@ Next assign `route-users` do `Distribution Groups`.
|
|||||||
<img src="/docs-static/img/manage/access-control/posture-checks/connecting-from-the-office/distribute-to-groups-posturechecks.png" alt="high-level-dia" className="imagewrapper"/>
|
<img src="/docs-static/img/manage/access-control/posture-checks/connecting-from-the-office/distribute-to-groups-posturechecks.png" alt="high-level-dia" className="imagewrapper"/>
|
||||||
</p>
|
</p>
|
||||||
Click `Continue` and assign the name "Office network access" to `Network Identifier`, click `Continue` agaom and in the final step, finish this process by clicking `Add Route`.
|
Click `Continue` and assign the name "Office network access" to `Network Identifier`, click `Continue` agaom and in the final step, finish this process by clicking `Add Route`.
|
||||||
<p>
|
|
||||||
<img src="/docs-static/img/manage/access-control/posture-checks/connecting-from-the-office/route-office-subnet-posturecheck.png" alt="high-level-dia" className="imagewrapper"/>
|
|
||||||
</p>
|
|
||||||
### Testing Posture Check
|
### Testing Posture Check
|
||||||
Now that we have created the Posture Check, the Policy, and the Network Route, we can test this configuration. In the following example, we will be testing this Posture Check from a macOS client named `client-01`, and as stated earlier, it belongs to the group `route-users`.
|
Now that we have created the Posture Check, the Policy, and the Network Route, we can test this configuration. In the following example, we will be testing this Posture Check from a macOS client named `client-01`, and as stated earlier, it belongs to the group `route-users`.
|
||||||
|
|
||||||
|
|||||||
@@ -201,7 +201,7 @@ The following guide is an adapted version of the original
|
|||||||
#### Expected Result
|
#### Expected Result
|
||||||
|
|
||||||
After completing this guide, you can log in to your self-hosted NetBird Dashboard and add your machines
|
After completing this guide, you can log in to your self-hosted NetBird Dashboard and add your machines
|
||||||
to your network using the [Interactive SSO Login feature](/how-to/getting-started#running-net-bird-with-sso-login)
|
to your network using the [Interactive SSO Login feature](/get-started/install#running-net-bird-with-sso-login)
|
||||||
over Keycloak.
|
over Keycloak.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
@@ -1180,7 +1180,7 @@ This Auth0 API will be used to access NetBird Management Service API.
|
|||||||
|
|
||||||
#### Step 4: Enable Interactive SSO Login (Optional)
|
#### Step 4: Enable Interactive SSO Login (Optional)
|
||||||
|
|
||||||
The [Interactive SSO Login feature](/how-to/installation#running-net-bird-with-sso-login) allows for machine
|
The [Interactive SSO Login feature](/get-started/install#running-net-bird-with-sso-login) allows for machine
|
||||||
authorization with your Identity Provider. This feature can be used as an alternative to [setup keys](/how-to/register-machines-using-setup-keys)
|
authorization with your Identity Provider. This feature can be used as an alternative to [setup keys](/how-to/register-machines-using-setup-keys)
|
||||||
and is optional.
|
and is optional.
|
||||||
|
|
||||||
|
|||||||