+ PowerDNS +
+PowerDNS information
+diff --git a/content/en/docs/Core_Applications/PowerDNS/_index.md b/content/en/docs/Core_Applications/PowerDNS/_index.md new file mode 100644 index 0000000..9a7ce17 --- /dev/null +++ b/content/en/docs/Core_Applications/PowerDNS/_index.md @@ -0,0 +1,15 @@ + +--- +title: "PowerDNS" +linkTitle: "PowerDNS" +date: 2023-05-30 +description: > + PowerDNS information +--- + +{{% pageinfo %}} +This documentation is for users and administrators, not those wanting to install. +{{% /pageinfo %}} + +Access to PowerDNS is at: https://powerdns.domain.com where "domain.com" is your domain name. + diff --git a/content/en/docs/Core_Applications/Traefik/_index.md b/content/en/docs/Core_Applications/Traefik/_index.md new file mode 100644 index 0000000..29415ef --- /dev/null +++ b/content/en/docs/Core_Applications/Traefik/_index.md @@ -0,0 +1,15 @@ + +--- +title: "Traefik" +linkTitle: "Traefik" +date: 2023-05-30 +description: > + Information +--- + +{{% pageinfo %}} +This documentation is for users and administrators, not those wanting to install. +{{% /pageinfo %}} + +Access to Traefik is at: https://traefik.domain.com where "domain.com" is your domain name. + diff --git a/content/en/docs/Getting started/welcome.md b/content/en/docs/Getting started/welcome.md index 942697c..2a147f6 100644 --- a/content/en/docs/Getting started/welcome.md +++ b/content/en/docs/Getting started/welcome.md @@ -1,49 +1,40 @@ ---- -title: "Welcome to Federated Core" -linkTitle: "Welcome" -date: 2017-01-05 -description: > - A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs. ---- +Dear Federated Customer, -{{% pageinfo %}} -This documentation is for users and administrators, not those wanting to install. -{{% /pageinfo %}} +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: -The following information is sent to each new Federated Core customer. +Website: https://support.federated.computer +Phone: 415-779-5431 +Email: support@federated.computer -> 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: +We are here to help you, the Customer, get the most out of your Federated Core. -> Phone: 415-779-5431 +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. -> 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... -> Note: Replace {domain.com} with the information you used when registering for the service. - -**Admin User** +**[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. -> User name = "admin@{domain.com}", -> Password = "{password}" +Username = "admin@{domain.com}" +Password = "{password}" You should log into "Panel" (see next section) and change the password. -**Panel** +**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. -**Email** +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. @@ -52,43 +43,64 @@ 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} +**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/core_applications/nextcloud for more information and other documentation. +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} +Username: admin@domain.com +Password: As given above + +**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/core_applications/jitsi for more information and other documentation. +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. -**Element**: https://element.{domain.com} +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/core_applications/element for more information and other documentation. +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. -**Listmonk**: https://listmonk.{domain.com} +User administration is done in Panel. -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/core_applications/listmonk. +**Listmonk: https://listmonk.{domain.com}** -**Baserow**: https://baserow.{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. -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/core_applications/baserow. +There is only one user for Listmonk: -**Vaultwarden**: https://vaultwarden.{domain.com} +* Listmonk Admin User: listmonk +* Listmonk Admin Password: {} -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/core_applications/vaultwarden. +**Baserow: https://baserow.{domain.com}** -**Gitea**: https://gitea.{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. -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/core_applications/gitea. +User administration is done in Baserow, but you set up users using the admin user given above. -**VPN/Wireguard** +**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: @@ -96,17 +108,19 @@ Your core comes with a very powerful VPN solution built using Wireguard. The fol Address = {IP} PrivateKey = {privatekey} -ListenPort = XXXXX +ListenPort = 51820 DNS = {IP} 1. VPN Peer PublicKey = {publickey} PresharedKey = {presharedkey} -Endpoint = vpn.{domain.com}:XXXXX -AllowedIPs = XXX.XX.XX.XX/XX +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/core_applications/vpn. +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}** @@ -114,20 +128,30 @@ A very powerful tool for managing the DNS of your domain. Your Federated Core ha 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. -* 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 9fffe4f..cb08fba 100644 --- a/public/docs/client_applications/android/index.html +++ b/public/docs/client_applications/android/index.html @@ -94,7 +94,7 @@ Getting Started
PowerDNS information
+Information
+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.
+ +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.
+ +A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
+This documentation is for users and administrators, not those wanting to install.
- -The following information is sent to each new Federated Core customer.
---Dear Federated Customer,
+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:
-
--Phone: 415-779-5431
-
--Email: support@federated.computer
-
+-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…
---Note: Replace {domain.com} with the information you used when registering for the service.
-
Admin User
+[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.
--User name = “admin@{domain.com}”, +
Username = “admin@{domain.com}” Password = “{password}”
-
You should log into “Panel” (see next section) and change the password.
-Panel
+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}
+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/core_applications/nextcloud for more information and other documentation.
-Jitsi: https://jitsi.{domain.com}
+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
+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/core_applications/jitsi for more information and other documentation.
-Element: https://element.{domain.com}
+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/core_applications/element for more information and other documentation.
+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.
-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/core_applications/listmonk.
-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/core_applications/baserow.
-Vaultwarden: 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/core_applications/vaultwarden.
-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/core_applications/gitea.
-VPN/Wireguard
+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:
+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:
Address = {IP} PrivateKey = {privatekey} -ListenPort = XXXXX +ListenPort = 51820 DNS = {IP}
PublicKey = {publickey} PresharedKey = {presharedkey} -Endpoint = vpn.{domain.com}:XXXXX -AllowedIPs = XXX.XX.XX.XX/XX
-Additional information about the VPN service can be found at https://documentation.federated.computer/core_applications/vpn.
+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.
-Support: https://support.federated.computer +Phone: 415-779-5431 +Email: support@federated.computer
It’s your computer. Let’s make it work for you!
diff --git a/public/docs/index.html b/public/docs/index.html index bf7f49c..39d7b0e 100644 --- a/public/docs/index.html +++ b/public/docs/index.html @@ -90,7 +90,7 @@ Getting Started