2023-06-01 17:23:31 +00:00
<!doctype html>
< html itemscope itemtype = "http://schema.org/WebPage" lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" >
< meta name = "generator" content = "Hugo 0.92.2" / >
< link rel = "alternate" type = "application/rss+xml" href = "/docs/getting_started/welcome/index.xml" >
< meta name = "robots" content = "index, follow" >
< link rel = "shortcut icon" href = "/favicons/favicon.ico" >
< link rel = "apple-touch-icon" href = "/favicons/apple-touch-icon-180x180.png" sizes = "180x180" >
< link rel = "icon" type = "image/png" href = "/favicons/favicon-16x16.png" sizes = "16x16" >
< link rel = "icon" type = "image/png" href = "/favicons/favicon-32x32.png" sizes = "32x32" >
< link rel = "icon" type = "image/png" href = "/favicons/android-36x36.png" sizes = "36x36" >
< link rel = "icon" type = "image/png" href = "/favicons/android-48x48.png" sizes = "48x48" >
< link rel = "icon" type = "image/png" href = "/favicons/android-72x72.png" sizes = "72x72" >
< link rel = "icon" type = "image/png" href = "/favicons/android-96x96.png" sizes = "96x96" >
< link rel = "icon" type = "image/png" href = "/favicons/android-144x144.png" sizes = "144x144" >
< link rel = "icon" type = "image/png" href = "/favicons/android-192x192.png" sizes = "192x192" >
< title > Welcome Document | Federated Docs< / title >
< meta name = "description" content = "The Welcome Document for Federated Core .
">
< meta property = "og:title" content = "Welcome Document" / >
< meta property = "og:description" content = "The Welcome Document for Federated Core .
" />
< meta property = "og:type" content = "website" / >
< meta property = "og:url" content = "/docs/getting_started/welcome/" / >
< meta itemprop = "name" content = "Welcome Document" >
< meta itemprop = "description" content = "The Welcome Document for Federated Core .
">< meta name = "twitter:card" content = "summary" / >
< meta name = "twitter:title" content = "Welcome Document" / >
< meta name = "twitter:description" content = "The Welcome Document for Federated Core .
"/>
< link rel = "preload" href = "/scss/main.min.43ad6541a45f31cd03dd1066a29ba2595ef582b492c6241a2288367893840e77.css" as = "style" >
< link href = "/scss/main.min.43ad6541a45f31cd03dd1066a29ba2595ef582b492c6241a2288367893840e77.css" rel = "stylesheet" integrity = "" >
< script
src="https://code.jquery.com/jquery-3.6.0.min.js"
integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK"
crossorigin="anonymous">< / script >
< / head >
< body class = "td-section" >
< header >
< nav class = "js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar" >
< a class = "navbar-brand" href = "/" > < span class = "navbar-brand__logo navbar-logo" > < svg id = "Layer_1" xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" viewBox = "0 0 500 500" style = "enable-background:new 0 0 500 500" > < g > < path style = "fill:#fff" d = "M116.8525 421.9722c-5.7041.0-10.3442-4.3127-10.3442-9.6129V88.183c0-5.3002 4.6401-9.6117 10.3442-9.6117H320.858c3.0347.0 9.3959.5498 11.7506 2.6302l.3545.3442 58.905 63.2912c2.3101 2.491 2.9202 8.4928 2.9202 11.3184v256.2039c0 5.3002-4.6407 9.6129-10.3436 9.6129H116.8525z" / > < g > < g > < g > < path style = "fill:#767676" d = "M384.4445 423.2066H116.852c-6.3839.0-11.5786-4.8658-11.5786-10.8474V88.1831c0-5.9804 5.1947-10.8461 11.5786-10.8461h204.0062c.377.0 9.2786.0329 12.568 2.9389l.3947.3833 58.9508 63.337c3.2135 3.4652 3.2514 11.7924 3.2514 12.1593v256.2036C396.0231 418.3408 390.8284 423.2066 384.4445 423.2066zM116.5079 411.9189c.0848.0278.1999.0531.3441.0531h267.5925c.1442.0.2581-.0253.3441-.0531V156.1556c-.0076-.9033-.3593-3.7347-.7034-5.0037l-57.6527-61.9416c-1.4651-.3176-4.4533-.6389-5.5742-.6389H116.852c-.143.0-.2594.024-.3441.0531V411.9189zm267.4533-261.149zM327.0321 89.371v.0013V89.371z" / > < / g > < / g > < / g > < g > < g > < path style = "fill:#5b7fc0" d = "M189.0874 210.1754l.0012-.0012c7.7751.0012 15.0295 4.1862 18.932 10.9234 1.9177 3.3159 2.9305 7.1011 2.9293 10.9378.0 5.8394-2.2733 11.3304-6.4032 15.4604-4.1288 4.1288-9.6186 6.4032-15.458 6.4032s-11.328-2.2733-15.458-6.4032-6.4032-9.6186-6.4056-15.4628c.0012-6.025 2.454-11.4897 6.4116-15.4473C177.5953 212.627 183.0601 210.1742 189.0874 210.1754zm7.993 21.8576c.0012-1.4042-.3687-2.7868-1.063-3.9887-1.4293-2.4684-4.0833-3.9995-6.9299-4.0019-4.4077.0024-7.993 3.5877-7.993 7.993.0 2.1356.832 4.1431 2.3427 5.6539 1.5083 1.5083 3.5159 2.3403 5.6503 2.3415 2.1356.0 4.1443-.8308 5.6539-2.3403S197.0816 234.1722 197.0804 232.033z" / > < path style = "opacity:.3;fill:#fff" d = "M189.0898 210.176c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 212.6276 183.0612 210.176 189.0898 210.176zm7.9941 21.8612c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 236.239 197.0839 234.2399 197.0839 232.0372z" / > < g > < defs > < path id = "SVGID_1_" d = "M194.7376 237.6875c-1.4461 1.4461-3.4452 2.3439-5.6479 2.3439-4.4077-.0024-7.9918-3.5865-7.9942-7.9942.0024-4.4125 3.5937-7.999 7.9942-7.9942 2.8443.0 5.497 1.5323 6.924 3.9983.6991 1.2067 1.0702 2.5881 1.0702 3.9959C197.0839 234.2399 196.1861 236.239 194.7376 237.6875z" / > < / defs > < clipPath id = "SVGID_2_" > < use xlink:href = "#SVGID_1_" style = "overflow:visible" / > < / clipPath > < path style = "clip-path:url(#SVGID_2_);fill:#fff" d = "M190.0704 225.0237c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 225.7247 191.9774 225.0237 190.0704 225.0237z" / > < path style = "opacity:.13;clip-path:url(#SVGID_2_);fill:#020202" d = "M190.0704 225.0237c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 225.7247 191.9774 225.0237 190.0704 225.0237z" / > < / g > < g > < defs > < path id = "SVGID_3_" d = "M189.0898 210.176c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 212.6276 183.0612 210.176 189.0898 210.176zm7.9941 21.8612c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 236.239 197.0839 234.2399 197.0839 232.0372z" / > < / defs > < clipPath id = "
< div class = "td-navbar-nav-scroll ml-md-auto" id = "main_navbar" >
< ul class = "navbar-nav mt-2 mt-lg-0" >
< li class = "nav-item mr-4 mb-2 mb-lg-0" >
< a class = "nav-link" href = "/about/" > < span > About< / span > < / a >
< / li >
< li class = "nav-item mr-4 mb-2 mb-lg-0" >
< a class = "nav-link active" href = "/docs/" > < span class = "active" > Documentation< / span > < / a >
< / li >
< li class = "nav-item mr-4 mb-2 mb-lg-0" >
< a class = "nav-link" href = "/blog/" > < span > Blog< / span > < / a >
< / li >
< li class = "nav-item mr-4 mb-2 mb-lg-0" >
< a class = "nav-link" href = "/community/" > < span > Community< / span > < / a >
< / li >
< / ul >
< / div >
< div class = "navbar-nav d-none d-lg-block" >
< / div >
< / nav >
< / header >
< div class = "container-fluid td-outer" >
< div class = "td-main" >
< div class = "row flex-xl-nowrap" >
< aside class = "col-12 col-md-3 col-xl-2 td-sidebar d-print-none" >
< div id = "td-sidebar-menu" class = "td-sidebar__inner" >
< form class = "td-sidebar__search d-flex align-items-center" >
< button class = "btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type = "button" data-toggle = "collapse" data-target = "#td-section-nav" aria-controls = "td-section-nav" aria-expanded = "false" aria-label = "Toggle section navigation" >
< / button >
< / form >
< nav class = "collapse td-sidebar-nav" id = "td-section-nav" >
< ul class = "td-sidebar-nav__section pr-md-3 ul-0" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id = "m-docs-li" >
< a href = "/docs/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section tree-root" id = "m-docs" > < span class = "" > Documentation< / span > < / a >
< ul class = "ul-1" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsoverview-li" >
< a href = "/docs/overview/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsoverview" > < span class = "" > Overview< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id = "m-docsgetting_started-li" >
< a href = "/docs/getting_started/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsgetting_started" > < span class = "" > Getting Started< / span > < / a >
< ul class = "ul-2 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id = "m-docsgetting_startedwelcome-li" >
< a href = "/docs/getting_started/welcome/" class = "align-left pl-0 active td-sidebar-link td-sidebar-link__section" id = "m-docsgetting_startedwelcome" > < span class = "td-sidebar-nav-active-item" > Welcome Document< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docscore_applications-li" >
< a href = "/docs/core_applications/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applications" > < span class = "" > Core Applications< / span > < / a >
< ul class = "ul-2 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationsbaserow-li" >
< a href = "/docs/core_applications/baserow/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationsbaserow" > < span class = "" > Baserow< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationspanel-li" >
< a href = "/docs/core_applications/panel/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationspanel" > < span class = "" > Panel< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationspowerdns-li" >
< a href = "/docs/core_applications/powerdns/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationspowerdns" > < span class = "" > PowerDNS< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationswireguard-li" >
< a href = "/docs/core_applications/wireguard/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationswireguard" > < span class = "" > Wireguard< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationselement-li" >
< a href = "/docs/core_applications/element/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationselement" > < span class = "" > Element< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationsgitea-li" >
< a href = "/docs/core_applications/gitea/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationsgitea" > < span class = "" > Gitea< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationsjitsi-li" >
< a href = "/docs/core_applications/jitsi/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationsjitsi" > < span class = "" > Jitsi< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationslistmonk-li" >
< a href = "/docs/core_applications/listmonk/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationslistmonk" > < span class = "" > Listmonk< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationsnextcloud-li" >
< a href = "/docs/core_applications/nextcloud/" title = "Nextcloud" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationsnextcloud" > < span class = "" > Nexcloud< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscore_applicationsvaultwarden-li" >
< a href = "/docs/core_applications/vaultwarden/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscore_applicationsvaultwarden" > < span class = "" > Vaultwarden< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsclient_applications-li" >
< a href = "/docs/client_applications/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applications" > < span class = "" > Client Applications< / span > < / a >
< ul class = "ul-2 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsbrowsers-li" >
< a href = "/docs/client_applications/browsers/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsbrowsers" > < span class = "" > Browsers< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsclient_applicationswindows-li" >
< a href = "/docs/client_applications/windows/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationswindows" > < span class = "" > Windows< / span > < / a >
< ul class = "ul-3 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowselement-li" >
< a href = "/docs/client_applications/windows/element/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationswindowselement" > < span class = "" > Element< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowsmail-li" >
< a href = "/docs/client_applications/windows/mail/" title = "Mail for Windows" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationswindowsmail" > < span class = "" > Mail< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowsnextcloud-li" >
< a href = "/docs/client_applications/windows/nextcloud/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationswindowsnextcloud" > < span class = "" > Nextcloud Applications< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowsnotes-li" >
< a href = "/docs/client_applications/windows/notes/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationswindowsnotes" > < span class = "" > Notes< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowsoutlook-li" >
< a href = "/docs/client_applications/windows/outlook/" title = "Outlook for Windows" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationswindowsoutlook" > < span class = "" > Outlook< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowsthunderbird-li" >
< a href = "/docs/client_applications/windows/thunderbird/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationswindowsthunderbird" > < span class = "" > Thunderbird< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowswireguard-li" >
< a href = "/docs/client_applications/windows/wireguard/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationswindowswireguard" > < span class = "" > Wireguard< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationswindowsoffice-li" >
< a href = "/docs/client_applications/windows/office/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationswindowsoffice" > < span class = "" > Office Suite< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsclient_applicationsandroid-li" >
< a href = "/docs/client_applications/android/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsandroid" > < span class = "" > Android< / span > < / a >
< ul class = "ul-3 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsandroidthird-party-li" >
< a href = "/docs/client_applications/android/third-party/" title = "Third Party Applications" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationsandroidthird-party" > < span class = "" > 3rd Party Applications< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsandroidnextcloud-applications-li" >
< a href = "/docs/client_applications/android/nextcloud-applications/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationsandroidnextcloud-applications" > < span class = "" > Nextcloud Applications< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsclient_applicationsios-li" >
< a href = "/docs/client_applications/ios/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsios" > < span class = "" > iOS< / span > < / a >
< ul class = "ul-3 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsiosconfiguring-ponycopters-li" >
< a href = "/docs/client_applications/ios/configuring-ponycopters/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationsiosconfiguring-ponycopters" > < span class = "" > Configuring Ponycopters< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsclient_applicationslinux-li" >
< a href = "/docs/client_applications/linux/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationslinux" > < span class = "" > Linux< / span > < / a >
< ul class = "ul-3 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxelement-li" >
< a href = "/docs/client_applications/linux/element/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationslinuxelement" > < span class = "" > Element< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxnextcloud-li" >
< a href = "/docs/client_applications/linux/nextcloud/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationslinuxnextcloud" > < span class = "" > Nextcloud Applications< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxnotes-li" >
< a href = "/docs/client_applications/linux/notes/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationslinuxnotes" > < span class = "" > Notes< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxthunderbird-li" >
< a href = "/docs/client_applications/linux/thunderbird/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationslinuxthunderbird" > < span class = "" > Thunderbird< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxubuntu-li" >
< a href = "/docs/client_applications/linux/ubuntu/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationslinuxubuntu" > < span class = "" > Ubuntu-based Distribution< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxwireguard-li" >
< a href = "/docs/client_applications/linux/wireguard/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationslinuxwireguard" > < span class = "" > Wireguard< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationslinuxoffice-li" >
< a href = "/docs/client_applications/linux/office/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationslinuxoffice" > < span class = "" > Office Suite< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsclient_applicationsmacos-li" >
< a href = "/docs/client_applications/macos/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsmacos" > < span class = "" > MacOS< / span > < / a >
< ul class = "ul-3 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacoselement-li" >
< a href = "/docs/client_applications/macos/element/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationsmacoselement" > < span class = "" > Element< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacosnextcloud-li" >
< a href = "/docs/client_applications/macos/nextcloud/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationsmacosnextcloud" > < span class = "" > Nextcloud Applications< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacosnotes-li" >
< a href = "/docs/client_applications/macos/notes/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsmacosnotes" > < span class = "" > Notes< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacosthunderbird-li" >
< a href = "/docs/client_applications/macos/thunderbird/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsmacosthunderbird" > < span class = "" > Thunderbird< / span > < / a >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacoswireguard-li" >
< a href = "/docs/client_applications/macos/wireguard/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsclient_applicationsmacoswireguard" > < span class = "" > Wireguard< / span > < / a >
2023-06-01 20:28:26 +00:00
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacosmacos-li" >
< a href = "/docs/client_applications/macos/macos/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsmacosmacos" > < span class = "" > Connecting macOS< / span > < / a >
2023-06-01 17:23:31 +00:00
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsclient_applicationsmacosoffice-li" >
< a href = "/docs/client_applications/macos/office/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsclient_applicationsmacosoffice" > < span class = "" > Office Suite< / span > < / a >
< / li >
< / ul >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section with-child" id = "m-docsother_topics-li" >
< a href = "/docs/other_topics/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docsother_topics" > < span class = "" > Other Topics< / span > < / a >
< ul class = "ul-2 foldable" >
< li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docsother_topicsmigration-li" >
< a href = "/docs/other_topics/migration/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__page" id = "m-docsother_topicsmigration" > < span class = "" > Migration to Federated Core< / span > < / a >
< / li >
< / ul >
< / li > < li class = "td-sidebar-nav__section-title td-sidebar-nav__section without-child" id = "m-docscontribution-guidelines-li" >
< a href = "/docs/contribution-guidelines/" class = "align-left pl-0 td-sidebar-link td-sidebar-link__section" id = "m-docscontribution-guidelines" > < span class = "" > Contribution Guidelines< / span > < / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / aside >
< aside class = "d-none d-xl-block col-xl-2 td-sidebar-toc d-print-none" >
< div class = "td-page-meta ml-2 pb-1 pt-2 mb-0" >
< a href = "https://gitea.federated.computer/documentation.federated.computer//tree/main/content/en/docs/getting_started/welcome/_index.md" class = "td-page-meta--view" target = "_blank" rel = "noopener" > < i class = "fa-solid fa-file-lines fa-fw" > < / i > View page source< / a >
< a href = "https://gitea.federated.computer/documentation.federated.computer//edit/main/content/en/docs/getting_started/welcome/_index.md" class = "td-page-meta--edit" target = "_blank" rel = "noopener" > < i class = "fa-solid fa-pen-to-square fa-fw" > < / i > Edit this page< / a >
< a href = "https://gitea.federated.computer/documentation.federated.computer//new/main/content/en/docs/getting_started/welcome/_index.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" class = "td-page-meta--child" target = "_blank" rel = "noopener" > < i class = "fa-solid fa-pen-to-square fa-fw" > < / i > Create child page< / a >
< a href = "https://gitea.federated.computer/documentation.federated.computer//issues/new?title=Welcome%20Document" class = "td-page-meta--issue" target = "_blank" rel = "noopener" > < i class = "fa-solid fa-list-check fa-fw" > < / i > Create documentation issue< / a >
< / div >
< / aside >
< main class = "col-12 col-md-9 col-xl-8 pl-md-5" role = "main" >
< nav aria-label = "breadcrumb" class = "td-breadcrumbs" >
< ol class = "breadcrumb" >
< li class = "breadcrumb-item" >
< a href = "/docs/" > Documentation< / a >
< / li >
< li class = "breadcrumb-item" >
< a href = "/docs/getting_started/" > Getting Started< / a >
< / li >
< li class = "breadcrumb-item active" aria-current = "page" >
< a href = "/docs/getting_started/welcome/" aria-disabled = "true" class = "btn-link disabled" > Welcome Document< / a >
< / li >
< / ol >
< / nav >
< div class = "td-content" >
< h1 > Welcome Document< / h1 >
< div class = "lead" > The Welcome Document for Federated Core.< / div >
< header class = "article-meta" >
< / header >
< div class = "pageinfo pageinfo-primary" >
< p > This documentation is for users and administrators, not those wanting to install.< / p >
< / div >
< blockquote >
< p > Note: This document is sent to the administrator of a Federated Core. It is monstly relevant to that person.< / p >
< / blockquote >
< p > Dear Federated Customer,< / p >
< p > Please read this note in its entirety since it has some important information for you to get the best use out of your Federated Core. If you ever get stuck for whatever reason, please reach out to us for support:< / p >
< p > Website: < a href = "https://support.federated.computer" > https://support.federated.computer< / a >
Phone: 415-779-5431
Email: < a href = "mailto:support@federated.computer" > support@federated.computer< / a > < / p >
< p > We are here to help you, the Customer, get the most out of your Federated Core.< / p >
< p > All documentation for your Federated Core can be found at < a href = "https://documentation.federated.computer" > https://documentation.federated.computer< / a > . There you’ ll find tips for how to use your Core and the various open source applications bundled with your Core.< / p >
< p > The information in this document is for the Admin User only. See the documentation pages for information pertinent to users.< / p >
< p > Here are some quick pointers… < / p >
< p > < strong > [Admin User]< / strong > < / p >
< p > There is an “ admin” or administrative use that has access to everything on your Federated Core. Here are the credentials for that user.< / p >
< ul >
< li > Username = “ admin@{domain.com}” < / li >
< li > Password = “ {password}” < / li >
< / ul >
< p > You should log into “ Panel” (see next section) and change the password.< / p >
< p > < strong > Panel: https://panel.{domain.com)< / strong > < / p >
< p > Your control panel for users for most Federated Core apps and services is here: https://panel.{domain.com}. You will log in with the admin user and, then change the password (and ideally, save this password in a safe place for later reference).< / p >
< p > You can also use Panel to < strong > create new user accounts for your team< / strong > . You are able to give certain users administrative privileges, but please be cautious.< / p >
< p > Additional documentation about the Panel service can be found at < a href = "https://documentation.federated.computer/docs/core_applications/panel" > https://documentation.federated.computer/docs/core_applications/panel< / a > .< / p >
< ul >
< li > Username: admin< / li >
< li > Password: as given above< / li >
< / ul >
< p > < strong > [Email]< / strong > < / p >
< p > Your email server has the following settings you can use to configure mobile and desktop email clients. Note: Nextcloud (next section) has a built-in web email client.< / p >
< ul >
< li > SMTP: Server is “ mail.{domain.com}” and the port is “ 465” .< / li >
< li > IMAP: Server is “ mail.{domain.com}” and the port is “ 993” .< / li >
< / ul >
< p > The user and password for the email service is the full email address and password as assigned in Panel (see above). Example: < a href = "mailto:rupert@federated.computer" > rupert@federated.computer< / a > , 56tasty23.< / p >
< p > < strong > Nextcloud: https://nextcloud.{domain.com}< / strong > < / p >
< p > The Nextcloud suite (replacing Google Workplace) provides apps and services covering mail, calendar, contacts, notes, tasks, files, word processing, spreadsheets, slides, project management (deck), bookmarks, forms, team talk, pictures, and an activity monitor. The user and password for the Nextcloud service is the full email address and password as assigned in Panel (see above). Example: < a href = "mailto:rupert@federated.computer" > rupert@federated.computer< / a > , 56tasty23.< / p >
< p > There are a number of additional clients for mobile and desktop that work with Nextcloud. Please see < a href = "https://documentation.federated.computer/docs/core_applications/nextcloud" > https://documentation.federated.computer/docs/core_applications/nextcloud< / a > for more information and other documentation.< / p >
< ul >
< li > Username: < a href = "mailto:admin@domain.com" > admin@domain.com< / a > < / li >
< li > Password: As given above< / li >
< / ul >
< p > < strong > Jitsi: https://jitsi.{domain.com}< / strong > < / p >
< p > Jitsi (your Zoom replacement) is a wonderful video conferencing solution. We have tuned Jitsi so that your Core can handle video conferences up to 8 people. NOTE, at this time the user and password for the Jitsi service is the user name ALONE and password as assigned in Panel (see above). Example: rupert, 56tasty23.< / p >
< p > There are a number of mobile and desktop clients available to use with the Jitsi service. Please see < a href = "https://documentation.federated.computer/docs/core_applications/jitsi" > https://documentation.federated.computer/docs/core_applications/jitsi< / a > for more information and other documentation.< / p >
< ul >
< li > User administration is done in Panel.< / li >
< / ul >
< p > < strong > Element: https://element.{domain.com}< / strong > < / p >
< p > Element (a Slack replacement) provides you the ability to chat and communicate in real time with those on your team and outside of the team.< / p >
< p > There are a number of mobile and desktop clients available to use with the Element service. Please see < a href = "https://documentation.federated.computer/docs/core_applications/element" > https://documentation.federated.computer/docs/core_applications/element< / a > for more information and other documentation.< / p >
< p > There are three services that do < em > not< / em > use panel for user creation and management. This is for various reasons either based on the constraints for the current application, or so that you can share the system easily with users outside your team without giving access to other parts of your system.< / p >
< ul >
< li > User administration is done in Panel.< / li >
< / ul >
< p > < strong > Listmonk: https://listmonk.{domain.com}< / strong > < / p >
< p > Listmonk is a replacement for Mailchimp. You can set up and manage the email lists used to send out marketing messages. Listmonk is a single-user system and the user name is “ listmonk@{domain.com}” and the password is {password}. For more information, please see the documentation < a href = "https://documentation.federated.computer/docs/core_applications/listmonk" > https://documentation.federated.computer/docs/core_applications/listmonk< / a > .< / p >
< p > There is only one user for Listmonk:< / p >
< ul >
< li > Listmonk Admin User: listmonk< / li >
< li > Listmonk Admin Password: {}< / li >
< / ul >
< p > < strong > Baserow: https://baserow.{domain.com}< / strong > < / p >
< p > Baserow (an Airtable replacement) allows you to create customized databases without writing any code. It’ s an amazing product. The user authentication for Baserow is separate from Federated Core. To set up the service, log in as your “ admin@{domain.com}” user with the correct password. You invite other users to Baserow within the service. For more information, please see the documentation < a href = "https://documentation.federated.computer/docs/core_applications/baserow" > https://documentation.federated.computer/docs/core_applications/baserow< / a > .< / p >
< ul >
< li > User administration is done in Baserow, but you set up users using the admin user given above.< / li >
< / ul >
< p > < strong > Vaultwaden: https://vaultwarden.{domain.com}< / strong > < / p >
< p > Vaultwarden is a password manager. The user authentication for Vaultwarden is separate from Federated Core. To set up the service, log in as your “ admin@{your_domain.com}” user with the correct password. You invite other users to Vaultwarden within the service itself. For more information, please see the documentation < a href = "https://documentation.federated.computer/docs/core_applications/vaultwarden" > https://documentation.federated.computer/docs/core_applications/vaultwarden< / a > .< / p >
< ul >
< li > User administration is done in Vaultwarden, but you set up users using the admin user given above.< / li >
< / ul >
< p > < strong > Gitea: https://gitea.{domain.com}< / strong > < / p >
< p > Gitea is a code repository and management system similar to Github. The user authentication is seperate from Federated Core. To set up the service, log in as your “ admin@{your_domain.com}” user with the correct password. You invite other users to Gitea within the service itself. For more information, please see the documentation < a href = "https://documentation.federated.computer/docs/core_applications/gitea" > https://documentation.federated.computer/docs/core_applications/gitea< / a > .< / p >
< ul >
< li >
< p > User administration is done in Gitea.< / p >
< / li >
< li >
< p > Gitea Admin User: gitea< / p >
< / li >
< li >
< p > Gitea Admin Password: as given above< / p >
< / li >
< / ul >
< p > < strong > VPN< / strong > < / p >
< p > Your core comes with a very powerful VPN solution built using Wireguard. The following information is needed by your users so that they can use the VPN. Please treat this information as a very important secret. There are two important parts of the VPN:< / p >
< ol >
< li > VPN Interface< / li >
< / ol >
< ul >
< li > Address = {IP}< / li >
< li > PrivateKey = {privatekey}< / li >
< li > ListenPort = 51820< / li >
< li > DNS = {IP}< / li >
< / ul >
< ol start = "2" >
< li > VPN Peer< / li >
< / ol >
< ul >
< li > PublicKey = {publickey}< / li >
< li > PresharedKey = {presharedkey}< / li >
< li > Endpoint = vpn.{domain.com}:51820< / li >
< li > AllowedIPs = 172.99.0.0/24< / li >
< / ul >
< p > Additional information about the VPN service can be found at < a href = "https://documentation.federated.computer/docs/core_applications/vpn" > https://documentation.federated.computer/docs/core_applications/vpn< / a > .< / p >
< ul >
< li > User administration is done in Panel.< / li >
< / ul >
< p > < strong > PowerDNS: https://powerdns.{domain.com}< / strong > < / p >
< p > A very powerful tool for managing the DNS of your domain. Your Federated Core has a number of sub-domains pre-configured (examples: mail.domain.com, jitsi.domain.com, etc.) But if you need another sub-domain to connect your domain to a service outside your Federated Core, use PowerDNS.< / p >
< p > Additional information about the PowerDNS service can be found at < a href = "https://documentation.federated.computer/docs/core_applications/powerdns" > https://documentation.federated.computer/docs/core_applications/powerdns< / a > .< / p >
< p > Only the admin user has access to this service.< / p >
< ul >
< li > Username: admin< / li >
< li > Password: as given above< / li >
< / ul >
< p > < strong > Thanks and Additional Support< / strong > < / p >
< p > Thank you for your support of Federated. We really appreciate it and hope you have a very successful time with Federated Core.< / p >
< p > Again, if we can be of any assistance, please don’ t hesitate to get in touch. Don’ t hesitate.< / p >
< ul >
< li > Support: < a href = "https://support.federated.computer" > https://support.federated.computer< / a > < / li >
< li > Phone: 415-779-5431< / li >
< li > Email: < a href = "mailto:support@federated.computer" > support@federated.computer< / a > < / li >
< / ul >
< p > < strong > It’ s your computer. Let’ s make it work for you!< / strong > < / p >
< div class = "section-index" >
< / div >
< / div >
< / main >
< / div >
< / div >
< footer class = "bg-dark py-5 row d-print-none" >
< div class = "container-fluid mx-sm-5" >
< div class = "row" >
< div class = "col-6 col-sm-4 text-xs-center order-sm-2" >
< ul class = "list-inline mb-0" >
< li class = "list-inline-item mx-2 h3" data-toggle = "tooltip" data-placement = "top" title = "User mailing list" aria-label = "User mailing list" >
< a class = "text-white" target = "_blank" rel = "noopener" href = "https://federated.computer/customers" aria-label = "User mailing list" >
< i class = "fa fa-envelope" > < / i >
< / a >
< / li >
< li class = "list-inline-item mx-2 h3" data-toggle = "tooltip" data-placement = "top" title = "Twitter" aria-label = "Twitter" >
< a class = "text-white" target = "_blank" rel = "noopener" href = "https://twitter.com/federatedworld" aria-label = "Twitter" >
< i class = "fab fa-twitter" > < / i >
< / a >
< / li >
< / ul >
< / div >
< div class = "col-6 col-sm-4 text-right text-xs-center order-sm-3" >
< ul class = "list-inline mb-0" >
< li class = "list-inline-item mx-2 h3" data-toggle = "tooltip" data-placement = "top" title = "GitHub" aria-label = "GitHub" >
< a class = "text-white" target = "_blank" rel = "noopener" href = "https://github.com/federatedcomputer" aria-label = "GitHub" >
< i class = "fab fa-github" > < / i >
< / a >
< / li >
< li class = "list-inline-item mx-2 h3" data-toggle = "tooltip" data-placement = "top" title = "Developer mailing list" aria-label = "Developer mailing list" >
< a class = "text-white" target = "_blank" rel = "noopener" href = "https://federated.computer/developers" aria-label = "Developer mailing list" >
< i class = "fa fa-envelope" > < / i >
< / a >
< / li >
< / ul >
< / div >
< div class = "col-12 col-sm-4 text-center py-2 order-sm-2" >
< small class = "text-white" > © 2023 Federated Computer, Inc. All Rights Reserved< / small >
< small class = "ml-1" > < a href = "https://federated.computer" target = "_blank" rel = "noopener" > Privacy Policy< / a > < / small >
< p class = "mt-2" > < a href = "/about/" > About Federated Core< / a > < / p >
< / div >
< / div >
< / div >
< / footer >
< / div >
< script src = "/js/main.min.8741557c571337827a7eb4977ad59c86860ae95b8e86a17138d36f059fa5fe23.js" integrity = "sha256-h0FVfFcTN4J6frSXetWchoYK6VuOhqFxONNvBZ+l/iM=" crossorigin = "anonymous" > < / script >
< script src = '/js/tabpane-persist.js' > < / script >
< / body >
< / html >
