diff --git a/content/en/docs/Core_Applications/Gitea/_index.md b/content/en/docs/Core_Applications/Gitea/_index.md index 2c5c09f..9d30a47 100644 --- a/content/en/docs/Core_Applications/Gitea/_index.md +++ b/content/en/docs/Core_Applications/Gitea/_index.md @@ -13,5 +13,3 @@ This documentation is for users and administrators, not those wanting to install Access to Gitea is at: https://gitea.domain.com where "domain.com" is your domain name. - - diff --git a/content/en/docs/Core_Applications/PowerDNS/_index.md b/content/en/docs/Core_Applications/PowerDNS/_index.md index 9a7ce17..8a7198c 100644 --- a/content/en/docs/Core_Applications/PowerDNS/_index.md +++ b/content/en/docs/Core_Applications/PowerDNS/_index.md @@ -13,3 +13,11 @@ This documentation is for users and administrators, not those wanting to install Access to PowerDNS is at: https://powerdns.domain.com where "domain.com" is your domain name. +> Note: this service is restricted to the administrative user for your Federated Core. + +Username: admin +Password: password for the admin user. + +Click on you domain and then add an "A" record to add additional sub-domains. + +PowerDNS [Support Guide](https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/.github/SUPPORT.md). \ No newline at end of file diff --git a/content/en/docs/Core_Applications/Traefik/_index.md b/content/en/docs/Core_Applications/Traefik/_index.md index 29415ef..097b2ca 100644 --- a/content/en/docs/Core_Applications/Traefik/_index.md +++ b/content/en/docs/Core_Applications/Traefik/_index.md @@ -13,3 +13,11 @@ This documentation is for users and administrators, not those wanting to install Access to Traefik is at: https://traefik.domain.com where "domain.com" is your domain name. +> Note: this service is restricted to the administrative user for your Federated Core. + +You probably don't want to screw around with this service. Ha! + +This service is part of your Federated Core so that multiple domain names can be supported accross the various services. The networking inside Federated Core is complicated! But you don't need to worry about that. It works! + +If there is something you'd like to do with Traefik and need help, please reach out to use for assistance. We're happy to work with you. + diff --git a/content/en/docs/Core_Applications/Wireguard/_index.md b/content/en/docs/Core_Applications/Wireguard/_index.md index 12f21f8..8e327b5 100644 --- a/content/en/docs/Core_Applications/Wireguard/_index.md +++ b/content/en/docs/Core_Applications/Wireguard/_index.md @@ -2,16 +2,22 @@ --- title: "Wireguard" linkTitle: "Wireguard" -date: 2017-01-05 +date: 2023-05-30 description: > - A short lead description about this section page. Text here can also be **bold** or _italic_ and can even be split over multiple paragraphs. + Wireguard is your VPN service allowing you to use your Federated Core entirely privately as well as access outside services from your Federated Core rather than the IP address of your desktop computer or mobile device. --- {{% pageinfo %}} This documentation is for users and administrators, not those wanting to install. {{% /pageinfo %}} -Access to Baserow is at: https://baserow.domain.com where "domain.com" is your domain name. +Access to Wireguard is entirely through the Wireguard application on your desktop computer or mobile device. Please look at the Wireguard section of Client Applications of the documentation for information on different types of supported device. -This is the section landing page. +You will need to have the "tunnel" information for your Wireguard service. It is provided to you when your Federated Core is installed. + +> Note for administrators: you can save the Wireguard tunnel information in a file and distribute that to your users. + +> Note: please save the file as a ".conf" file so that it is recognized by the Wireguard client software. + +> Suggestion: use the format "wg0.conf" for your Wireguard file. You can then email this file to all your users. diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/getting_started/_index.md similarity index 93% rename from content/en/docs/Getting started/_index.md rename to content/en/docs/getting_started/_index.md index 2991d84..4f11e4e 100644 --- a/content/en/docs/Getting started/_index.md +++ b/content/en/docs/getting_started/_index.md @@ -35,8 +35,6 @@ The document "Welcome to Federated Core" provides a detailed listing of services If you have problems setting up your Federated Core, please reach out to customer support for assistance. -https://support.federated.computer - -Phone: 415-779-3333 - -Email: support@federated.computer \ No newline at end of file +* https://support.federated.computer +* Phone: 415-779-3333 +* Email: support@federated.computer \ No newline at end of file diff --git a/content/en/docs/Getting started/welcome.md b/content/en/docs/getting_started/welcome/_index.md similarity index 83% rename from content/en/docs/Getting started/welcome.md rename to content/en/docs/getting_started/welcome/_index.md index 2a147f6..0a30609 100644 --- a/content/en/docs/Getting started/welcome.md +++ b/content/en/docs/getting_started/welcome/_index.md @@ -1,3 +1,17 @@ +--- +title: "Welcome Document" +linkTitle: "Welcome Document" +weight: 2 +description: > + The Welcome Document for Federated Core. +--- + +{{% pageinfo %}} +This documentation is for users and administrators, not those wanting to install. +{{% /pageinfo %}} + +> Note: This document is sent to the administrator of a Federated Core. It is monstly relevant to that person. + Dear Federated Customer, 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: @@ -18,8 +32,8 @@ Here are some quick pointers... There is an "admin" or administrative use that has access to everything on your Federated Core. Here are the credentials for that user. -Username = "admin@{domain.com}" -Password = "{password}" +* Username = "admin@{domain.com}" +* Password = "{password}" You should log into "Panel" (see next section) and change the password. @@ -31,15 +45,15 @@ You can also use Panel to **create new user accounts for your team**. You are ab Additional documentation about the Panel service can be found at https://documentation.federated.computer/docs/core_applications/panel. -Username: admin -Password: as given above +* Username: admin +* Password: as given above **[Email]** 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. -SMTP: Server is "mail.{domain.com}" and the port is "465". -IMAP: Server is "mail.{domain.com}" and the port is "993". +* SMTP: Server is "mail.{domain.com}" and the port is "465". +* IMAP: Server is "mail.{domain.com}" and the port is "993". The user and password for the email service is the full email address and password as assigned in Panel (see above). Example: rupert@federated.computer, 56tasty23. @@ -49,8 +63,8 @@ The Nextcloud suite (replacing Google Workplace) provides apps and services cove There are a number of additional clients for mobile and desktop that work with Nextcloud. Please see https://documentation.federated.computer/docs/core_applications/nextcloud for more information and other documentation. -Username: admin@domain.com -Password: As given above +* Username: admin@domain.com +* Password: As given above **Jitsi: https://jitsi.{domain.com}** @@ -58,7 +72,7 @@ Jitsi (your Zoom replacement) is a wonderful video conferencing solution. We hav There are a number of mobile and desktop clients available to use with the Jitsi service. Please see https://documentation.federated.computer/docs/core_applications/jitsi for more information and other documentation. -User administration is done in Panel. +* User administration is done in Panel. **Element: https://element.{domain.com}** @@ -68,7 +82,7 @@ There are a number of mobile and desktop clients available to use with the Eleme There are three services that do *not* 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. -User administration is done in Panel. +* User administration is done in Panel. **Listmonk: https://listmonk.{domain.com}** @@ -83,22 +97,22 @@ There is only one user for Listmonk: 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 https://documentation.federated.computer/docs/core_applications/baserow. -User administration is done in Baserow, but you set up users using the admin user given above. +* User administration is done in Baserow, but you set up users using the admin user given above. **Vaultwaden: https://vaultwarden.{domain.com}** 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 https://documentation.federated.computer/docs/core_applications/vaultwarden. -User administration is done in Vaultwarden, but you set up users using the admin user given above. +* User administration is done in Vaultwarden, but you set up users using the admin user given above. **Gitea: https://gitea.{domain.com}** 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 https://documentation.federated.computer/docs/core_applications/gitea. -User administration is done in Gitea. +* User administration is done in Gitea. -Gitea Admin User: gitea -Gitea Admin Password: as given above +* Gitea Admin User: gitea +* Gitea Admin Password: as given above **VPN** @@ -106,21 +120,21 @@ Your core comes with a very powerful VPN solution built using Wireguard. The fol 1. VPN Interface -Address = {IP} -PrivateKey = {privatekey} -ListenPort = 51820 -DNS = {IP} +* Address = {IP} +* PrivateKey = {privatekey} +* ListenPort = 51820 +* DNS = {IP} -1. VPN Peer +2. VPN Peer -PublicKey = {publickey} -PresharedKey = {presharedkey} -Endpoint = vpn.{domain.com}:51820 -AllowedIPs = 172.99.0.0/24 +* PublicKey = {publickey} +* PresharedKey = {presharedkey} +* Endpoint = vpn.{domain.com}:51820 +* AllowedIPs = 172.99.0.0/24 Additional information about the VPN service can be found at https://documentation.federated.computer/docs/core_applications/vpn. -User administration is done in Panel. +* User administration is done in Panel. **PowerDNS: https://powerdns.{domain.com}** @@ -130,8 +144,8 @@ Additional information about the PowerDNS service can be found at https://docume Only the admin user has access to this service. -Username: admin -Password: as given above +* Username: admin +* Password: as given above **Traefik: https://traefik.{domain.com}** @@ -141,8 +155,8 @@ Additional information about the VPN service can be found at https://documentati Only the admin user has access to this service. -Username: admin -Password: as given above +* Username: admin +* Password: as given above **Thanks and Additional Support** @@ -150,8 +164,8 @@ Thank you for your support of Federated. We really appreciate it and hope you ha Again, if we can be of any assistance, please don't hesitate to get in touch. Don't hesitate. -Support: https://support.federated.computer -Phone: 415-779-5431 -Email: support@federated.computer +* Support: https://support.federated.computer +* Phone: 415-779-5431 +* Email: support@federated.computer **It's your computer. Let's make it work for you!** \ No newline at end of file diff --git a/public/docs/client_applications/android/index.html b/public/docs/client_applications/android/index.html index cb08fba..38ac385 100644 --- a/public/docs/client_applications/android/index.html +++ b/public/docs/client_applications/android/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/android/nextcloud-applications/index.html b/public/docs/client_applications/android/nextcloud-applications/index.html index 0efab1a..649057e 100644 --- a/public/docs/client_applications/android/nextcloud-applications/index.html +++ b/public/docs/client_applications/android/nextcloud-applications/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/android/third-party/index.html b/public/docs/client_applications/android/third-party/index.html index 04a7f26..59b555f 100644 --- a/public/docs/client_applications/android/third-party/index.html +++ b/public/docs/client_applications/android/third-party/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/browsers/index.html b/public/docs/client_applications/browsers/index.html index 732062c..8049216 100644 --- a/public/docs/client_applications/browsers/index.html +++ b/public/docs/client_applications/browsers/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/index.html b/public/docs/client_applications/index.html index ebe3cb4..b7b8d2a 100644 --- a/public/docs/client_applications/index.html +++ b/public/docs/client_applications/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/ios/configuring-ponycopters/index.html b/public/docs/client_applications/ios/configuring-ponycopters/index.html index ea9723d..d1c6533 100644 --- a/public/docs/client_applications/ios/configuring-ponycopters/index.html +++ b/public/docs/client_applications/ios/configuring-ponycopters/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/ios/index.html b/public/docs/client_applications/ios/index.html index 4a456e5..ddc5854 100644 --- a/public/docs/client_applications/ios/index.html +++ b/public/docs/client_applications/ios/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/linux/element/index.html b/public/docs/client_applications/linux/element/index.html index edb55d9..eefbb02 100644 --- a/public/docs/client_applications/linux/element/index.html +++ b/public/docs/client_applications/linux/element/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/linux/index.html b/public/docs/client_applications/linux/index.html index 8558aa4..8036fcc 100644 --- a/public/docs/client_applications/linux/index.html +++ b/public/docs/client_applications/linux/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/linux/nextcloud/index.html b/public/docs/client_applications/linux/nextcloud/index.html index 0f06d6e..38ca725 100644 --- a/public/docs/client_applications/linux/nextcloud/index.html +++ b/public/docs/client_applications/linux/nextcloud/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/linux/notes/index.html b/public/docs/client_applications/linux/notes/index.html index 08c9f2b..1db9dcc 100644 --- a/public/docs/client_applications/linux/notes/index.html +++ b/public/docs/client_applications/linux/notes/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/linux/office/index.html b/public/docs/client_applications/linux/office/index.html index 4541343..840fa52 100644 --- a/public/docs/client_applications/linux/office/index.html +++ b/public/docs/client_applications/linux/office/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/linux/thunderbird/index.html b/public/docs/client_applications/linux/thunderbird/index.html index 48f97f7..06f5b71 100644 --- a/public/docs/client_applications/linux/thunderbird/index.html +++ b/public/docs/client_applications/linux/thunderbird/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/linux/ubuntu/index.html b/public/docs/client_applications/linux/ubuntu/index.html index 093edd9..85ba1ad 100644 --- a/public/docs/client_applications/linux/ubuntu/index.html +++ b/public/docs/client_applications/linux/ubuntu/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/linux/wireguard/index.html b/public/docs/client_applications/linux/wireguard/index.html index 0e1e375..38ca9f7 100644 --- a/public/docs/client_applications/linux/wireguard/index.html +++ b/public/docs/client_applications/linux/wireguard/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/macos/configuring-ponycopters/index.html b/public/docs/client_applications/macos/configuring-ponycopters/index.html index dce3925..2d5d5c6 100644 --- a/public/docs/client_applications/macos/configuring-ponycopters/index.html +++ b/public/docs/client_applications/macos/configuring-ponycopters/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/macos/element/index.html b/public/docs/client_applications/macos/element/index.html index fea1f63..b88b427 100644 --- a/public/docs/client_applications/macos/element/index.html +++ b/public/docs/client_applications/macos/element/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/macos/index.html b/public/docs/client_applications/macos/index.html index 42ebc45..913603d 100644 --- a/public/docs/client_applications/macos/index.html +++ b/public/docs/client_applications/macos/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/macos/nextcloud/index.html b/public/docs/client_applications/macos/nextcloud/index.html index 66f57fa..488fe08 100644 --- a/public/docs/client_applications/macos/nextcloud/index.html +++ b/public/docs/client_applications/macos/nextcloud/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/macos/notes/index.html b/public/docs/client_applications/macos/notes/index.html index 634f3b2..911b83b 100644 --- a/public/docs/client_applications/macos/notes/index.html +++ b/public/docs/client_applications/macos/notes/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/macos/office/index.html b/public/docs/client_applications/macos/office/index.html index 7186b56..7a39838 100644 --- a/public/docs/client_applications/macos/office/index.html +++ b/public/docs/client_applications/macos/office/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/macos/thunderbird/index.html b/public/docs/client_applications/macos/thunderbird/index.html index 27b2bfc..e6ebb67 100644 --- a/public/docs/client_applications/macos/thunderbird/index.html +++ b/public/docs/client_applications/macos/thunderbird/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/macos/wireguard/index.html b/public/docs/client_applications/macos/wireguard/index.html index 03523ff..7ca00a0 100644 --- a/public/docs/client_applications/macos/wireguard/index.html +++ b/public/docs/client_applications/macos/wireguard/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/windows/element/index.html b/public/docs/client_applications/windows/element/index.html index df326d9..81f52ba 100644 --- a/public/docs/client_applications/windows/element/index.html +++ b/public/docs/client_applications/windows/element/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/windows/index.html b/public/docs/client_applications/windows/index.html index b13614f..86638ba 100644 --- a/public/docs/client_applications/windows/index.html +++ b/public/docs/client_applications/windows/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/windows/mail/index.html b/public/docs/client_applications/windows/mail/index.html index fc6256b..53c7a93 100644 --- a/public/docs/client_applications/windows/mail/index.html +++ b/public/docs/client_applications/windows/mail/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/windows/nextcloud/index.html b/public/docs/client_applications/windows/nextcloud/index.html index 9f08781..cded225 100644 --- a/public/docs/client_applications/windows/nextcloud/index.html +++ b/public/docs/client_applications/windows/nextcloud/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/windows/notes/index.html b/public/docs/client_applications/windows/notes/index.html index f9f9f30..20ad0e3 100644 --- a/public/docs/client_applications/windows/notes/index.html +++ b/public/docs/client_applications/windows/notes/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/windows/office/index.html b/public/docs/client_applications/windows/office/index.html index f54a06a..aefa271 100644 --- a/public/docs/client_applications/windows/office/index.html +++ b/public/docs/client_applications/windows/office/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/windows/outlook/index.html b/public/docs/client_applications/windows/outlook/index.html index 62423ef..8146dd4 100644 --- a/public/docs/client_applications/windows/outlook/index.html +++ b/public/docs/client_applications/windows/outlook/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/client_applications/windows/thunderbird/index.html b/public/docs/client_applications/windows/thunderbird/index.html index c6d0296..4530f03 100644 --- a/public/docs/client_applications/windows/thunderbird/index.html +++ b/public/docs/client_applications/windows/thunderbird/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/client_applications/windows/wireguard/index.html b/public/docs/client_applications/windows/wireguard/index.html index d97fb47..e20e14b 100644 --- a/public/docs/client_applications/windows/wireguard/index.html +++ b/public/docs/client_applications/windows/wireguard/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/contribution-guidelines/index.html b/public/docs/contribution-guidelines/index.html index 7530d45..eff434c 100644 --- a/public/docs/contribution-guidelines/index.html +++ b/public/docs/contribution-guidelines/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/baserow/index.html b/public/docs/core_applications/baserow/index.html index fb7d4e1..422e51a 100644 --- a/public/docs/core_applications/baserow/index.html +++ b/public/docs/core_applications/baserow/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/element/index.html b/public/docs/core_applications/element/index.html index 9b9e5c1..133bd18 100644 --- a/public/docs/core_applications/element/index.html +++ b/public/docs/core_applications/element/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/gitea/index.html b/public/docs/core_applications/gitea/index.html index 43aa70d..a842245 100644 --- a/public/docs/core_applications/gitea/index.html +++ b/public/docs/core_applications/gitea/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/index.html b/public/docs/core_applications/index.html index 1a6e14f..f3b9db5 100644 --- a/public/docs/core_applications/index.html +++ b/public/docs/core_applications/index.html @@ -90,11 +90,11 @@
  • @@ -351,6 +351,14 @@ +
    +
    + Wireguard +
    +

    Wireguard is your VPN service allowing you to use your Federated Core entirely privately as well as access outside services from your Federated Core rather than the IP address of your desktop computer or mobile device.

    +
    + +
    Element @@ -398,14 +406,6 @@

    A short lead description about this section page. Text here can also be bold or italic and can even be split over multiple paragraphs.

    - -
    -
    - Wireguard -
    -

    A short lead description about this section page. Text here can also be bold or italic and can even be split over multiple paragraphs.

    -
    - diff --git a/public/docs/core_applications/index.xml b/public/docs/core_applications/index.xml index fd6a701..0fcdc55 100644 --- a/public/docs/core_applications/index.xml +++ b/public/docs/core_applications/index.xml @@ -237,6 +237,13 @@ </div> <p>Access to PowerDNS is at: <a href="https://powerdns.domain.com">https://powerdns.domain.com</a> where &ldquo;domain.com&rdquo; is your domain name.</p> +<blockquote> +<p>Note: this service is restricted to the administrative user for your Federated Core.</p> +</blockquote> +<p>Username: admin +Password: password for the admin user.</p> +<p>Click on you domain and then add an &ldquo;A&rdquo; record to add additional sub-domains.</p> +<p>PowerDNS <a href="https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/.github/SUPPORT.md">Support Guide</a>.</p> @@ -258,6 +265,43 @@ </div> <p>Access to Traefik is at: <a href="https://traefik.domain.com">https://traefik.domain.com</a> where &ldquo;domain.com&rdquo; is your domain name.</p> +<blockquote> +<p>Note: this service is restricted to the administrative user for your Federated Core.</p> +</blockquote> +<p>You probably don&rsquo;t want to screw around with this service. Ha!</p> +<p>This service is part of your Federated Core so that multiple domain names can be supported accross the various services. The networking inside Federated Core is complicated! But you don&rsquo;t need to worry about that. It works!</p> +<p>If there is something you&rsquo;d like to do with Traefik and need help, please reach out to use for assistance. We&rsquo;re happy to work with you.</p> + + + + + + Docs: Wireguard + /docs/core_applications/wireguard/ + Tue, 30 May 2023 00:00:00 +0000 + + /docs/core_applications/wireguard/ + + + + + +<div class="pageinfo pageinfo-primary"> +<p>This documentation is for users and administrators, not those wanting to install.</p> + +</div> + +<p>Access to Wireguard is entirely through the Wireguard application on your desktop computer or mobile device. Please look at the Wireguard section of Client Applications of the documentation for information on different types of supported device.</p> +<p>You will need to have the &ldquo;tunnel&rdquo; information for your Wireguard service. It is provided to you when your Federated Core is installed.</p> +<blockquote> +<p>Note for administrators: you can save the Wireguard tunnel information in a file and distribute that to your users.</p> +</blockquote> +<blockquote> +<p>Note: please save the file as a &ldquo;.conf&rdquo; file so that it is recognized by the Wireguard client software.</p> +</blockquote> +<blockquote> +<p>Suggestion: use the format &ldquo;wg0.conf&rdquo; for your Wireguard file. You can then email this file to all your users.</p> +</blockquote> @@ -663,28 +707,6 @@ Password: your password.</p> -<div class="pageinfo pageinfo-primary"> -<p>This documentation is for users and administrators, not those wanting to install.</p> - -</div> - -<p>Access to Baserow is at: <a href="https://baserow.domain.com">https://baserow.domain.com</a> where &ldquo;domain.com&rdquo; is your domain name.</p> -<p>This is the section landing page.</p> - - - - - - Docs: Wireguard - /docs/core_applications/wireguard/ - Thu, 05 Jan 2017 00:00:00 +0000 - - /docs/core_applications/wireguard/ - - - - - <div class="pageinfo pageinfo-primary"> <p>This documentation is for users and administrators, not those wanting to install.</p> diff --git a/public/docs/core_applications/jitsi/index.html b/public/docs/core_applications/jitsi/index.html index 7f7b194..fff337c 100644 --- a/public/docs/core_applications/jitsi/index.html +++ b/public/docs/core_applications/jitsi/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/listmonk/index.html b/public/docs/core_applications/listmonk/index.html index b63a30b..1257b75 100644 --- a/public/docs/core_applications/listmonk/index.html +++ b/public/docs/core_applications/listmonk/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/nextcloud/index.html b/public/docs/core_applications/nextcloud/index.html index 618d818..b50b9a0 100644 --- a/public/docs/core_applications/nextcloud/index.html +++ b/public/docs/core_applications/nextcloud/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/panel/index.html b/public/docs/core_applications/panel/index.html index 5e1eba4..206ec42 100644 --- a/public/docs/core_applications/panel/index.html +++ b/public/docs/core_applications/panel/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/powerdns/index.html b/public/docs/core_applications/powerdns/index.html index c19380d..6323ca1 100644 --- a/public/docs/core_applications/powerdns/index.html +++ b/public/docs/core_applications/powerdns/index.html @@ -90,11 +90,11 @@
  • @@ -309,6 +309,13 @@

    Access to PowerDNS is at: https://powerdns.domain.com where “domain.com” is your domain name.

    +
    +

    Note: this service is restricted to the administrative user for your Federated Core.

    +
    +

    Username: admin +Password: password for the admin user.

    +

    Click on you domain and then add an “A” record to add additional sub-domains.

    +

    PowerDNS Support Guide.

    diff --git a/public/docs/core_applications/traefik/index.html b/public/docs/core_applications/traefik/index.html index 4e714b5..cc75f91 100644 --- a/public/docs/core_applications/traefik/index.html +++ b/public/docs/core_applications/traefik/index.html @@ -90,11 +90,11 @@
  • @@ -309,6 +309,12 @@

    Access to Traefik is at: https://traefik.domain.com where “domain.com” is your domain name.

    +
    +

    Note: this service is restricted to the administrative user for your Federated Core.

    +
    +

    You probably don’t want to screw around with this service. Ha!

    +

    This service is part of your Federated Core so that multiple domain names can be supported accross the various services. The networking inside Federated Core is complicated! But you don’t need to worry about that. It works!

    +

    If there is something you’d like to do with Traefik and need help, please reach out to use for assistance. We’re happy to work with you.

    diff --git a/public/docs/core_applications/vaultwarden/index.html b/public/docs/core_applications/vaultwarden/index.html index cee7a8c..277bbe8 100644 --- a/public/docs/core_applications/vaultwarden/index.html +++ b/public/docs/core_applications/vaultwarden/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/core_applications/wireguard/index.html b/public/docs/core_applications/wireguard/index.html index 7064e12..4916a85 100644 --- a/public/docs/core_applications/wireguard/index.html +++ b/public/docs/core_applications/wireguard/index.html @@ -20,19 +20,19 @@ Wireguard | Federated Docs - - - - @@ -90,11 +90,11 @@
  • @@ -283,7 +283,7 @@

    Wireguard

    -
    A short lead description about this section page. Text here can also be bold or italic and can even be split over multiple paragraphs.
    +
    Wireguard is your VPN service allowing you to use your Federated Core entirely privately as well as access outside services from your Federated Core rather than the IP address of your desktop computer or mobile device.
    @@ -308,8 +308,17 @@
    -

    Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.

    -

    This is the section landing page.

    +

    Access to Wireguard is entirely through the Wireguard application on your desktop computer or mobile device. Please look at the Wireguard section of Client Applications of the documentation for information on different types of supported device.

    +

    You will need to have the “tunnel” information for your Wireguard service. It is provided to you when your Federated Core is installed.

    +
    +

    Note for administrators: you can save the Wireguard tunnel information in a file and distribute that to your users.

    +
    +
    +

    Note: please save the file as a “.conf” file so that it is recognized by the Wireguard client software.

    +
    +
    +

    Suggestion: use the format “wg0.conf” for your Wireguard file. You can then email this file to all your users.

    +
    diff --git a/public/docs/core_applications/wireguard/index.xml b/public/docs/core_applications/wireguard/index.xml index ee14f96..49fb34b 100644 --- a/public/docs/core_applications/wireguard/index.xml +++ b/public/docs/core_applications/wireguard/index.xml @@ -4,7 +4,7 @@ /docs/core_applications/wireguard/ Recent content in Wireguard on Federated Docs Hugo -- gohugo.io - Thu, 05 Jan 2017 00:00:00 +0000 + Tue, 30 May 2023 00:00:00 +0000 diff --git a/public/docs/getting_started/index.html b/public/docs/getting_started/index.html new file mode 100644 index 0000000..d824b5c --- /dev/null +++ b/public/docs/getting_started/index.html @@ -0,0 +1,429 @@ + + + + + + + + + + + + + + + + + + + + + +Getting Started | Federated Docs + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +
    + + +
    + + + + + +
    +

    Getting Started

    +
    Welcome to Federated Core!
    +
    + + + + + + + + + + + + + + + +
    + + +
    +

    This documentation is for users and administrators, not those wanting to install.

    + +
    + +

    Federated Core is an easy-to-use, integrated suite of software.

    +

    Setting Up User Accounts

    +

    Use the Panel application to set up user accounts. These user accounts, for the most part, use their email and password to log into all other services.

    +

    Services That Do Not Use Panel for User Accounts

    +

    A few of the services on your Federated Core do not, currently, use Panel to manage users. This decision was made to allow you to use these services with people outside your domain/team without having to give them access to your email system, etc. The services with user-management outside of Panel are:

    +
      +
    • Baserow
      • +
    • Listmonk
      • +
    • Gitea
      • +
    • Vaultwarden
      • +
    +

    Welcome Document

    +

    The document “Welcome to Federated Core” provides a detailed listing of services and the easy way to use each of them and is provided to customers upon initial install.

    + +

    Customer Support

    +

    If you have problems setting up your Federated Core, please reach out to customer support for assistance.

    + + +
    + + + + + + + + +
    + + +
    +
    + Welcome Document +
    +

    The Welcome Document for Federated Core.

    +
    + + +
    + + + + +
    + +
    +
    +
    + + + + +
    + + + + + \ No newline at end of file diff --git a/public/docs/getting_started/index.xml b/public/docs/getting_started/index.xml new file mode 100644 index 0000000..ddeb996 --- /dev/null +++ b/public/docs/getting_started/index.xml @@ -0,0 +1,170 @@ + + + Federated Docs – Getting Started + /docs/getting_started/ + Recent content in Getting Started on Federated Docs + Hugo -- gohugo.io + + + + + + + + + + + Docs: Welcome Document + /docs/getting_started/welcome/ + Mon, 01 Jan 0001 00:00:00 +0000 + + /docs/getting_started/welcome/ + + + + + +<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&rsquo;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&hellip;</p> +<p><strong>[Admin User]</strong></p> +<p>There is an &ldquo;admin&rdquo; or administrative use that has access to everything on your Federated Core. Here are the credentials for that user.</p> +<ul> +<li>Username = &ldquo;admin@{domain.com}&rdquo;</li> +<li>Password = &ldquo;{password}&rdquo;</li> +</ul> +<p>You should log into &ldquo;Panel&rdquo; (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 &ldquo;mail.{domain.com}&rdquo; and the port is &ldquo;465&rdquo;.</li> +<li>IMAP: Server is &ldquo;mail.{domain.com}&rdquo; and the port is &ldquo;993&rdquo;.</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 &ldquo;listmonk@{domain.com}&rdquo; 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&rsquo;s an amazing product. The user authentication for Baserow is separate from Federated Core. To set up the service, log in as your &ldquo;admin@{domain.com}&rdquo; 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 &ldquo;admin@{your_domain.com}&rdquo; 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 &ldquo;admin@{your_domain.com}&rdquo; 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>Traefik: https://traefik.{domain.com}</strong></p> +<p>Another super-user tool. Traefik is a powerful &ldquo;application proxy&rdquo;.</p> +<p>Additional information about the VPN service can be found at <a href="https://documentation.federated.computer/docs/core_applications/traefik">https://documentation.federated.computer/docs/core_applications/traefik</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&rsquo;t hesitate to get in touch. Don&rsquo;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&rsquo;s your computer. Let&rsquo;s make it work for you!</strong></p> + + + + + + diff --git a/public/docs/getting_started/welcome/index.html b/public/docs/getting_started/welcome/index.html new file mode 100644 index 0000000..9c97428 --- /dev/null +++ b/public/docs/getting_started/welcome/index.html @@ -0,0 +1,532 @@ + + + + + + + + + + + + + + + + + + + + + +Welcome Document | Federated Docs + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +
    + + +
    + + + + + +
    +

    Welcome Document

    +
    The Welcome Document for Federated Core.
    +
    + + + + + + + + + + + + + + + +
    + + +
    +

    This documentation is for users and administrators, not those wanting to install.

    + +
    + +
    +

    Note: This document is sent to the administrator of a Federated Core. It is monstly relevant to that person.

    +
    +

    Dear Federated Customer,

    +

    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:

    +

    Website: https://support.federated.computer +Phone: 415-779-5431 +Email: support@federated.computer

    +

    We are here to help you, the Customer, get the most out of your Federated Core.

    +

    All documentation for your Federated Core can be found at https://documentation.federated.computer. There you’ll find tips for how to use your Core and the various open source applications bundled with your Core.

    +

    The information in this document is for the Admin User only. See the documentation pages for information pertinent to users.

    +

    Here are some quick pointers…

    +

    [Admin User]

    +

    There is an “admin” or administrative use that has access to everything on your Federated Core. Here are the credentials for that user.

    +
      +
    • Username = “admin@{domain.com}”
      • +
    • Password = “{password}”
      • +
    +

    You should log into “Panel” (see next section) and change the password.

    +

    Panel: https://panel.{domain.com)

    +

    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).

    +

    You can also use Panel to create new user accounts for your team. You are able to give certain users administrative privileges, but please be cautious.

    +

    Additional documentation about the Panel service can be found at https://documentation.federated.computer/docs/core_applications/panel.

    +
      +
    • Username: admin
      • +
    • Password: as given above
      • +
    +

    [Email]

    +

    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.

    +
      +
    • SMTP: Server is “mail.{domain.com}” and the port is “465”.
      • +
    • IMAP: Server is “mail.{domain.com}” and the port is “993”.
      • +
    +

    The user and password for the email service is the full email address and password as assigned in Panel (see above). Example: rupert@federated.computer, 56tasty23.

    +

    Nextcloud: https://nextcloud.{domain.com}

    +

    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: rupert@federated.computer, 56tasty23.

    +

    There are a number of additional clients for mobile and desktop that work with Nextcloud. Please see https://documentation.federated.computer/docs/core_applications/nextcloud for more information and other documentation.

    + +

    Jitsi: https://jitsi.{domain.com}

    +

    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.

    +

    There are a number of mobile and desktop clients available to use with the Jitsi service. Please see https://documentation.federated.computer/docs/core_applications/jitsi for more information and other documentation.

    +
      +
    • User administration is done in Panel.
      • +
    +

    Element: https://element.{domain.com}

    +

    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.

    +

    There are a number of mobile and desktop clients available to use with the Element service. Please see https://documentation.federated.computer/docs/core_applications/element for more information and other documentation.

    +

    There are three services that do not 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.

    +
      +
    • User administration is done in Panel.
      • +
    +

    Listmonk: https://listmonk.{domain.com}

    +

    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 https://documentation.federated.computer/docs/core_applications/listmonk.

    +

    There is only one user for Listmonk:

    +
      +
    • Listmonk Admin User: listmonk
      • +
    • Listmonk Admin Password: {}
      • +
    +

    Baserow: https://baserow.{domain.com}

    +

    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 https://documentation.federated.computer/docs/core_applications/baserow.

    +
      +
    • User administration is done in Baserow, but you set up users using the admin user given above.
      • +
    +

    Vaultwaden: https://vaultwarden.{domain.com}

    +

    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 https://documentation.federated.computer/docs/core_applications/vaultwarden.

    +
      +
    • User administration is done in Vaultwarden, but you set up users using the admin user given above.
      • +
    +

    Gitea: https://gitea.{domain.com}

    +

    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 https://documentation.federated.computer/docs/core_applications/gitea.

    +
      +
    • +

      User administration is done in Gitea.

      +
      • +
    • +

      Gitea Admin User: gitea

      +
      • +
    • +

      Gitea Admin Password: as given above

      +
      • +
    +

    VPN

    +

    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:

    +
      +
    1. VPN Interface
      2. +
    +
      +
    • Address = {IP}
      • +
    • PrivateKey = {privatekey}
      • +
    • ListenPort = 51820
      • +
    • DNS = {IP}
      • +
    +
      +
    1. VPN Peer
      2. +
    +
      +
    • PublicKey = {publickey}
      • +
    • PresharedKey = {presharedkey}
      • +
    • Endpoint = vpn.{domain.com}:51820
      • +
    • AllowedIPs = 172.99.0.0/24
      • +
    +

    Additional information about the VPN service can be found at https://documentation.federated.computer/docs/core_applications/vpn.

    +
      +
    • User administration is done in Panel.
      • +
    +

    PowerDNS: https://powerdns.{domain.com}

    +

    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.

    +

    Additional information about the PowerDNS service can be found at https://documentation.federated.computer/docs/core_applications/powerdns.

    +

    Only the admin user has access to this service.

    +
      +
    • Username: admin
      • +
    • Password: as given above
      • +
    +

    Traefik: https://traefik.{domain.com}

    +

    Another super-user tool. Traefik is a powerful “application proxy”.

    +

    Additional information about the VPN service can be found at https://documentation.federated.computer/docs/core_applications/traefik.

    +

    Only the admin user has access to this service.

    +
      +
    • Username: admin
      • +
    • Password: as given above
      • +
    +

    Thanks and Additional Support

    +

    Thank you for your support of Federated. We really appreciate it and hope you have a very successful time with Federated Core.

    +

    Again, if we can be of any assistance, please don’t hesitate to get in touch. Don’t hesitate.

    + +

    It’s your computer. Let’s make it work for you!

    + +
    + + + + + + + + + +
    + + + + +
    + +
    +
    +
    + + + + +
    + + + + + \ No newline at end of file diff --git a/public/docs/getting_started/welcome/index.xml b/public/docs/getting_started/welcome/index.xml new file mode 100644 index 0000000..4c1e173 --- /dev/null +++ b/public/docs/getting_started/welcome/index.xml @@ -0,0 +1,17 @@ + + + Federated Docs – Welcome Document + /docs/getting_started/welcome/ + Recent content in Welcome Document on Federated Docs + Hugo -- gohugo.io + + + + + + + + + + + diff --git a/public/docs/index.html b/public/docs/index.html index 39d7b0e..ff6e2bc 100644 --- a/public/docs/index.html +++ b/public/docs/index.html @@ -86,11 +86,11 @@
  • @@ -322,7 +322,7 @@
    - Getting Started + Getting Started

    Welcome to Federated Core!

    diff --git a/public/docs/index.xml b/public/docs/index.xml index 39c2eee..c040059 100644 --- a/public/docs/index.xml +++ b/public/docs/index.xml @@ -1082,112 +1082,5 @@ bar := &quot;foo&quot;; - - Docs: - /docs/getting-started/welcome/ - Mon, 01 Jan 0001 00:00:00 +0000 - - /docs/getting-started/welcome/ - - - - <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&rsquo;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&hellip;</p> -<p><strong>[Admin User]</strong></p> -<p>There is an &ldquo;admin&rdquo; or administrative use that has access to everything on your Federated Core. Here are the credentials for that user.</p> -<p>Username = &ldquo;admin@{domain.com}&rdquo; -Password = &ldquo;{password}&rdquo;</p> -<p>You should log into &ldquo;Panel&rdquo; (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> -<p>Username: admin -Password: as given above</p> -<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> -<p>SMTP: Server is &ldquo;mail.{domain.com}&rdquo; and the port is &ldquo;465&rdquo;. -IMAP: Server is &ldquo;mail.{domain.com}&rdquo; and the port is &ldquo;993&rdquo;.</p> -<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> -<p>Username: <a href="mailto:admin@domain.com">admin@domain.com</a> -Password: As given above</p> -<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> -<p>User administration is done in Panel.</p> -<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> -<p>User administration is done in Panel.</p> -<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 &ldquo;listmonk@{domain.com}&rdquo; 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&rsquo;s an amazing product. The user authentication for Baserow is separate from Federated Core. To set up the service, log in as your &ldquo;admin@{domain.com}&rdquo; 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> -<p>User administration is done in Baserow, but you set up users using the admin user given above.</p> -<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 &ldquo;admin@{your_domain.com}&rdquo; 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> -<p>User administration is done in Vaultwarden, but you set up users using the admin user given above.</p> -<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 &ldquo;admin@{your_domain.com}&rdquo; 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> -<p>User administration is done in Gitea.</p> -<p>Gitea Admin User: gitea -Gitea Admin Password: as given above</p> -<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> -<p>Address = {IP} -PrivateKey = {privatekey} -ListenPort = 51820 -DNS = {IP}</p> -<ol> -<li>VPN Peer</li> -</ol> -<p>PublicKey = {publickey} -PresharedKey = {presharedkey} -Endpoint = vpn.{domain.com}:51820 -AllowedIPs = 172.99.0.0/24</p> -<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> -<p>User administration is done in Panel.</p> -<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> -<p>Username: admin -Password: as given above</p> -<p><strong>Traefik: https://traefik.{domain.com}</strong></p> -<p>Another super-user tool. Traefik is a powerful &ldquo;application proxy&rdquo;.</p> -<p>Additional information about the VPN service can be found at <a href="https://documentation.federated.computer/docs/core_applications/traefik">https://documentation.federated.computer/docs/core_applications/traefik</a>.</p> -<p>Only the admin user has access to this service.</p> -<p>Username: admin -Password: as given above</p> -<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&rsquo;t hesitate to get in touch. Don&rsquo;t hesitate.</p> -<p>Support: <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><strong>It&rsquo;s your computer. Let&rsquo;s make it work for you!</strong></p> - - - - diff --git a/public/docs/other_topics/index.html b/public/docs/other_topics/index.html index 9f5b9c7..49bffc4 100644 --- a/public/docs/other_topics/index.html +++ b/public/docs/other_topics/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/docs/other_topics/migration/index.html b/public/docs/other_topics/migration/index.html index 72ded85..a45cbdc 100644 --- a/public/docs/other_topics/migration/index.html +++ b/public/docs/other_topics/migration/index.html @@ -94,11 +94,11 @@
  • diff --git a/public/docs/overview/index.html b/public/docs/overview/index.html index de2e8a1..c199fda 100644 --- a/public/docs/overview/index.html +++ b/public/docs/overview/index.html @@ -90,11 +90,11 @@
  • diff --git a/public/sitemap.xml b/public/sitemap.xml index 5f47d95..aa0d9be 100644 --- a/public/sitemap.xml +++ b/public/sitemap.xml @@ -70,7 +70,9 @@ /docs/client_applications/android/nextcloud-applications/ 2017-01-05T00:00:00+00:00 - /docs/getting-started/ + /docs/getting_started/ + + /docs/getting_started/welcome/ /docs/core_applications/ 2023-05-30T00:00:00+00:00 @@ -130,6 +132,9 @@ /docs/client_applications/windows/ 2023-05-30T00:00:00+00:00 + + /docs/core_applications/wireguard/ + 2023-05-30T00:00:00+00:00 /docs/client_applications/android/ 2017-01-05T00:00:00+00:00 @@ -163,11 +168,6 @@ /docs/core_applications/vaultwarden/ 2017-01-05T00:00:00+00:00 - - /docs/core_applications/wireguard/ - 2017-01-05T00:00:00+00:00 - - /docs/getting-started/welcome/ /about/