diff --git a/content/en/docs/Core_Applications/Baserow/_index.md b/content/en/docs/Core_Applications/Baserow/_index.md index abd5f48..6f132db 100644 --- a/content/en/docs/Core_Applications/Baserow/_index.md +++ b/content/en/docs/Core_Applications/Baserow/_index.md @@ -2,7 +2,7 @@ --- title: "Baserow" linkTitle: "Baserow" -date: 2017-01-05 +date: 2023-05-30 description: > [Baserow](https://baserow.io/) is a no-code database application allowing you to quickly create customized applications for your team and company. --- diff --git a/content/en/docs/Core_Applications/Gitea/_index.md b/content/en/docs/Core_Applications/Gitea/_index.md index f504117..2c5c09f 100644 --- a/content/en/docs/Core_Applications/Gitea/_index.md +++ b/content/en/docs/Core_Applications/Gitea/_index.md @@ -4,14 +4,14 @@ title: "Gitea" linkTitle: "Gitea" date: 2017-01-05 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. + Gitea is a full-featured, compatible replacement for Github and is used for source-code managment and control. --- {{% 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 Gitea is at: https://gitea.domain.com where "domain.com" is your domain name. + -This is the section landing page. diff --git a/content/en/docs/Core_Applications/Panel/_index.md b/content/en/docs/Core_Applications/Panel/_index.md index 4ba71e0..c8fb410 100644 --- a/content/en/docs/Core_Applications/Panel/_index.md +++ b/content/en/docs/Core_Applications/Panel/_index.md @@ -2,16 +2,72 @@ --- title: "Panel" linkTitle: "Panel" -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. + Panel is the control center for your Federated Core. --- {{% 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 Panel is at: https://panel.domain.com where "domain.com" is your domain name. -This is the section landing page. +Panel is where you manage users and user permissions for your Federated Core. +> Note: this information is only relevant to the administrative user and those given administrative rights. For information on how a user can change their password, please read [this document](). + +**Log In** + +Click the "Log In" at the top of the screen. + +{{< imgproc menu Resize "315x64" >}} +{{< /imgproc >}} + +Log into Panel using "admin" and the password for your administrative user. You can find the password in the "Welcome" information sent to your when your Federated Core was created AND you haven't changed your password. + +> Note: if you can't log into Panel, please reach out to us for help. While we don't know your password, we can reset it so that you can get access. + +{{< imgproc login Resize "753x242" >}} +{{< /imgproc >}} + +Once logged into Panel, you can create a user: + +{{< imgproc newuser Resize "754x633" >}} +{{< /imgproc >}} + +A few comments on this dialog box. + +* The "system name" is the part of the email address given to the user *before* the "@" symbol. +* The password you give must be "strong" so there is a helpful "Generate password" feature. It is suggested you use this and then have the user change password. +* The "Email these credentials to the user?" feature sends and email to the newly created Federated Core email address. Not very useful, we know. The user will have it as a reference. But, you should copy the password and send it to the new user using some method *outside* of your Federated Core. + +It is possible to make some of your users administrators. + +> Warning: be careful with this functionality because an administrator is able to do significant damage to your Federated Core, delete other user accounts, get access to sensitive date, etc. + +{{< imgproc groups Resize "1129x573" >}} +{{< /imgproc >}} + +Move the users to want to be administrators into/out of the "admin" group using the "<" and ">" buttons. + +> Warning: you can but you do not *want* to delete the "admin" group. That will make everyone very sad and you'll need to reach out to Federated support to bring joy back into your life. + +**User Password Change** + +If a user on your system wants to change password, have the user log into Panel with their system user (the part of the user's email address before the "@" symbol). + +Since the user is *not* an administrative user, they will be presented with a utility for changing password. + +{{< imgproc pass Resize "571x384" >}} +{{< /imgproc >}} + +The utility checks to ensure your password is sufficiently strong. Sorry, we don't want you to get hacked. + +**Need Support?** + +Need some support? Don't hesitate to reach out to Federated customer support: + +* https://support.federated.computer +* email: support@federated.computer +* phone: 415-779-3333 \ No newline at end of file diff --git a/content/en/docs/Core_Applications/Panel/groups.png b/content/en/docs/Core_Applications/Panel/groups.png new file mode 100644 index 0000000..f28e5bc Binary files /dev/null and b/content/en/docs/Core_Applications/Panel/groups.png differ diff --git a/content/en/docs/Core_Applications/Panel/login.png b/content/en/docs/Core_Applications/Panel/login.png new file mode 100644 index 0000000..8471097 Binary files /dev/null and b/content/en/docs/Core_Applications/Panel/login.png differ diff --git a/content/en/docs/Core_Applications/Panel/menu.png b/content/en/docs/Core_Applications/Panel/menu.png new file mode 100644 index 0000000..6ada06e Binary files /dev/null and b/content/en/docs/Core_Applications/Panel/menu.png differ diff --git a/content/en/docs/Core_Applications/Panel/newuser.png b/content/en/docs/Core_Applications/Panel/newuser.png new file mode 100644 index 0000000..629a16e Binary files /dev/null and b/content/en/docs/Core_Applications/Panel/newuser.png differ diff --git a/content/en/docs/Core_Applications/Panel/pass.png b/content/en/docs/Core_Applications/Panel/pass.png new file mode 100644 index 0000000..616d0d3 Binary files /dev/null and b/content/en/docs/Core_Applications/Panel/pass.png differ diff --git a/content/en/docs/Getting started/welcome.md b/content/en/docs/Getting started/welcome.md index c2c86f1..942697c 100644 --- a/content/en/docs/Getting started/welcome.md +++ b/content/en/docs/Getting started/welcome.md @@ -56,37 +56,37 @@ The user and password for the email service is the full email address and passwo 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/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/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/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/core_applications/jitsi for more information and other documentation. **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/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/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/listmonk. +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/baserow. +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/vaultwarden. +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/gitea. +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** @@ -106,14 +106,28 @@ 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/vpn. +Additional information about the VPN service can be found at https://documentation.federated.computer/core_applications/vpn. -> Thank you for your support of Federated. We really appreciate it and hope you have a very successful time with Federated Core. +**PowerDNS: https://powerdns.{domain.com}** -> Again, if we can be of any assistance, please don't hesitate to get in touch. Don't hesitate. +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. -> Phone: 415-779-5431 +Additional information about the PowerDNS service can be found at https://documentation.federated.computer/docs/core_applications/powerdns. -> Email: support@federated.computer +**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. + +**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!** \ 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 bc28916..9fffe4f 100644 --- a/public/docs/client_applications/android/index.html +++ b/public/docs/client_applications/android/index.html @@ -102,6 +102,8 @@