- Welcome to Federated Core + Welcome to Federated Core
A short lead description about this content page. It can be bold or italic and can be split over multiple paragraphs.
diff --git a/content/en/docs/Core_Applications/Baserow/_index.md b/content/en/docs/Core_Applications/Baserow/_index.md index 9a3a077..abd5f48 100644 --- a/content/en/docs/Core_Applications/Baserow/_index.md +++ b/content/en/docs/Core_Applications/Baserow/_index.md @@ -29,4 +29,6 @@ Once logged in, you can invite other team members to your installation. > Tip: You may want to use the email address as the username format for consistency sake with the rest of the Federated Core. +**Official Baserow User Documentation** + For additional information about using Baserow, please consult the [user documentation](https://baserow.io/user-docs). \ No newline at end of file diff --git a/content/en/docs/Core_Applications/Element/_index.md b/content/en/docs/Core_Applications/Element/_index.md index 5af1d43..083998f 100644 --- a/content/en/docs/Core_Applications/Element/_index.md +++ b/content/en/docs/Core_Applications/Element/_index.md @@ -23,3 +23,60 @@ Your Element credentials are as follows: You will see a login page the first time you connect to Element. +{{< imgproc login Resize "530x360" >}} +{{< /imgproc >}} + +Even though there is an option for "Create Account", new accounts are turned off so that random folks from the internet can't get onto your server. Accounts for Federated Core are create in "Panel" (with the exception of Listmonk, Vaultwarden, Baserow). + +Click the "Sign In" buttton. + +{{< imgproc edit Resize "757x510" >}} +{{< /imgproc >}} + +Your Matrix server should be automatically filled in for the "Homeserver". + +Sign in using: + +* Username: your Federated Core email address. +* Password: your Federated Core password. + +> Note: the "Forget password" functionality doesn't work since user accounts are managed outside Element and Matrix. + +Click the "Sign in" button. + +You're in Element using your own personal Matrix server. You can "federated" with the 100s of thousands of other Matrix servers around the globe. Check out the official user documentation below. + +**Important Note About Keys** + +Element and Matrix are end-to-end encrypted so that no one can snoop on your communications. However, this functionality comes with some responsibility. You need to backup your keys so that you can have access to your conversations when you decide to use the desktop or mobile Element application to connect with your Matrix server, log out and want to log back in, etc. + +Let's walk through the process of backing up your keys. + +Using the small circle that represents your account, click the circle and choose the option for "All settings". + +{{< imgproc dropdown Resize "321x346" >}} +{{< /imgproc >}} + +Once in "All settings", choose the option for "Security & Privacy". + +{{< imgproc securebackup Resize "538x117" >}} +{{< /imgproc >}} + +You want to select the option for "Set up Secure Backup". This will bring you to the "Set up Secure Backup" dialog. + +{{< imgproc setup Resize "599x453" >}} +{{< /imgproc >}} + +We recommend using the "Generate a Security Key" option. Click "Continue". You will be shown your key and ask how your want to save it. + +{{< imgproc keys Resize "596x368" >}} +{{< /imgproc >}} + +It is VERY important that you save this key is a secure place. You can use your Federated Core installation of Vaultwarden to save the key. This key is used when logging into the Element/Matrix service on your Federated Core elsewhere and you want to verify your identity. + +**Official Element User Documentation** + +For additional information about using Element, please consult the [user documentation](https://element.io/user-guide). Some of this documentation may not be relevant to your own installation of Element/Matrix based on how users are managed on your Federated Core. + + + diff --git a/content/en/docs/Core_Applications/Element/dropdown.png b/content/en/docs/Core_Applications/Element/dropdown.png new file mode 100644 index 0000000..b0a8754 Binary files /dev/null and b/content/en/docs/Core_Applications/Element/dropdown.png differ diff --git a/content/en/docs/Core_Applications/Element/edit.png b/content/en/docs/Core_Applications/Element/edit.png new file mode 100644 index 0000000..6ff7eaa Binary files /dev/null and b/content/en/docs/Core_Applications/Element/edit.png differ diff --git a/content/en/docs/Core_Applications/Element/keys.png b/content/en/docs/Core_Applications/Element/keys.png new file mode 100644 index 0000000..8b29211 Binary files /dev/null and b/content/en/docs/Core_Applications/Element/keys.png differ diff --git a/content/en/docs/Core_Applications/Element/login.png b/content/en/docs/Core_Applications/Element/login.png new file mode 100644 index 0000000..4a3b9ce Binary files /dev/null and b/content/en/docs/Core_Applications/Element/login.png differ diff --git a/content/en/docs/Core_Applications/Element/securebackup.png b/content/en/docs/Core_Applications/Element/securebackup.png new file mode 100644 index 0000000..992980c Binary files /dev/null and b/content/en/docs/Core_Applications/Element/securebackup.png differ diff --git a/content/en/docs/Core_Applications/Element/setup.png b/content/en/docs/Core_Applications/Element/setup.png new file mode 100644 index 0000000..f1b75d7 Binary files /dev/null and b/content/en/docs/Core_Applications/Element/setup.png differ diff --git a/content/en/docs/Core_Applications/Jitsi/_index.md b/content/en/docs/Core_Applications/Jitsi/_index.md index d59201a..21114c9 100644 --- a/content/en/docs/Core_Applications/Jitsi/_index.md +++ b/content/en/docs/Core_Applications/Jitsi/_index.md @@ -4,14 +4,57 @@ title: "Jitsi" linkTitle: "Jitsi" 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. + Jitsi is a secure videoconferencing application. No one is listening in. --- {{% 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 Jitsi is at: https://jitsi.domain.com where "domain.com" is your domain name. -This is the section landing page. +Your Federated Core includes a full-featured open-source video conferencing solution "Jitsi". + +**Constraints** + +Your Jitsi installation has been optimized and tuned for teams and can support up to 8 people on a conference using video and audio. These numbers are dependent on the amount of bandwidth available to each participant, network conditions between the participants. If you would like to build out capacity for larger video conferences, please contact us for support. + +**Credentials** + +While anyone in the world can participate in a Jitsi meeting, only a person with an account on your Federated Core can start a Jitsi meeting. + +As of today, Jitsi is the *one* service in Federated Core that does *not* use your email address for log. If you email address, for example, is "david@rewind.com", your Jitsi username would be "david". Your password is the same as other Federated Core services. + +Username: name without your domain name. +Password: your password. + +**Starting A Meeting** + +Simply go to the Jitsi application on your Federated Core. You start a meeting by giving it a name. + +{{< imgproc meeting Resize "636x318" >}} +{{< /imgproc >}} + +> Tip: these names can "persist", so you can treat them like "conference rooms" and re-use them over-and-over. For example, name your meeting "customerservice" and then the URL "https://jitsi.domain.com/customerservice" (where "domain.com" is your domain name) can be accessed easily, posted somewhere for later reference/use, etc. + +You are then asked for the name you want to use for the meeting. This can be whatever you want. + +{{< imgproc join Resize "499x452" >}} +{{< /imgproc >}} + +You may be asked if you are the "host" for the meeting. Click "I am the host." + +{{< imgproc host Resize "415x214" >}} +{{< /imgproc >}} + +Then you will be asked to authenticate so that just anyone off the internet can't use your Federated Core for meeting. + +{{< imgproc login Resize "420x325" >}} +{{< /imgproc >}} + +As stated above, your user name will be the part *before* the "@" symbol in your Federated Core email address. This is the only service, currently, on Federated Core that works this way. Your password is your password. + +**Official Jitsi User Documentation** + +Here is the *official* Jitsi [user documentation](https://jitsi.github.io/handbook/docs/user-guide/). diff --git a/content/en/docs/Core_Applications/Jitsi/host.png b/content/en/docs/Core_Applications/Jitsi/host.png new file mode 100644 index 0000000..c063c7a Binary files /dev/null and b/content/en/docs/Core_Applications/Jitsi/host.png differ diff --git a/content/en/docs/Core_Applications/Jitsi/join.png b/content/en/docs/Core_Applications/Jitsi/join.png new file mode 100644 index 0000000..13db91a Binary files /dev/null and b/content/en/docs/Core_Applications/Jitsi/join.png differ diff --git a/content/en/docs/Core_Applications/Jitsi/login.png b/content/en/docs/Core_Applications/Jitsi/login.png new file mode 100644 index 0000000..ea45339 Binary files /dev/null and b/content/en/docs/Core_Applications/Jitsi/login.png differ diff --git a/content/en/docs/Core_Applications/Jitsi/meeting.png b/content/en/docs/Core_Applications/Jitsi/meeting.png new file mode 100644 index 0000000..d079e0e Binary files /dev/null and b/content/en/docs/Core_Applications/Jitsi/meeting.png differ diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/Getting started/_index.md index bdecb83..68aa2bf 100644 --- a/content/en/docs/Getting started/_index.md +++ b/content/en/docs/Getting started/_index.md @@ -1,6 +1,4 @@ --- -categories: ["Documentation", "Getting Started"] -tags: ["started","docs"] title: "Getting Started" linkTitle: "Getting Started" weight: 2 @@ -12,6 +10,18 @@ description: > This documentation is for users and administrators, not those wanting to install. {{% /pageinfo %}} -Federated Core is an easy-to-use, integrated suite of software. You use the **Panel** application to set up user accounts and these user accounts, for the most part, use their email and password to log into all other services. +Federated Core is an easy-to-use, integrated suite of software. -Please read the "Welcome to Federated Core" page for a detailed listing of services and the easy way to use each of them. \ No newline at end of file +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. + +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. + +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/example-page.md b/content/en/docs/Getting started/welcome.md similarity index 99% rename from content/en/docs/Getting started/example-page.md rename to content/en/docs/Getting started/welcome.md index 12756a6..c2c86f1 100644 --- a/content/en/docs/Getting started/example-page.md +++ b/content/en/docs/Getting started/welcome.md @@ -1,6 +1,4 @@ --- -categories: ["Examples"] -tags: ["test", "sample", "docs"] title: "Welcome to Federated Core" linkTitle: "Welcome" date: 2017-01-05 diff --git a/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html b/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html index 7395057..a71760d 100644 --- a/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html +++ b/public/blog/2023/05/30/helping-with-federated-core-documentation/index.html @@ -141,23 +141,6 @@ -
- @@ -169,21 +152,6 @@ -+Tip: You may want to use the email address as the username format for consistency sake with the rest of the Federated Core.
Official Baserow User Documentation
For additional information about using Baserow, please consult the user documentation.
You will see a login page the first time you connect to Element.
+ + + + + + + + +Even though there is an option for “Create Account”, new accounts are turned off so that random folks from the internet can’t get onto your server. Accounts for Federated Core are create in “Panel” (with the exception of Listmonk, Vaultwarden, Baserow).
+Click the “Sign In” buttton.
+ + + + + + + + + +Your Matrix server should be automatically filled in for the “Homeserver”.
+Sign in using:
+++Note: the “Forget password” functionality doesn’t work since user accounts are managed outside Element and Matrix.
+
Click the “Sign in” button.
+You’re in Element using your own personal Matrix server. You can “federated” with the 100s of thousands of other Matrix servers around the globe. Check out the official user documentation below.
+Important Note About Keys
+Element and Matrix are end-to-end encrypted so that no one can snoop on your communications. However, this functionality comes with some responsibility. You need to backup your keys so that you can have access to your conversations when you decide to use the desktop or mobile Element application to connect with your Matrix server, log out and want to log back in, etc.
+Let’s walk through the process of backing up your keys.
+Using the small circle that represents your account, click the circle and choose the option for “All settings”.
+ + + + + + + + + +Once in “All settings”, choose the option for “Security & Privacy”.
+ + + + + + + + + +You want to select the option for “Set up Secure Backup”. This will bring you to the “Set up Secure Backup” dialog.
+ + + + + + + + + +We recommend using the “Generate a Security Key” option. Click “Continue”. You will be shown your key and ask how your want to save it.
+ + + + + + + + + +It is VERY important that you save this key is a secure place. You can use your Federated Core installation of Vaultwarden to save the key. This key is used when logging into the Element/Matrix service on your Federated Core elsewhere and you want to verify your identity.
+Official Element User Documentation
+For additional information about using Element, please consult the user documentation. Some of this documentation may not be relevant to your own installation of Element/Matrix based on how users are managed on your Federated Core.
+Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.
This is the section landing page.
A short lead description about this section page. Text here can also be bold or italic and can even be split over multiple paragraphs.
+Jitsi is a secure videoconferencing application. No one is listening in.
This is the section landing page.
+Access to Jitsi is at: https://jitsi.domain.com where “domain.com” is your domain name.
+Your Federated Core includes a full-featured open-source video conferencing solution “Jitsi”.
+Constraints
+Your Jitsi installation has been optimized and tuned for teams and can support up to 8 people on a conference using video and audio. These numbers are dependent on the amount of bandwidth available to each participant, network conditions between the participants. If you would like to build out capacity for larger video conferences, please contact us for support.
+Credentials
+While anyone in the world can participate in a Jitsi meeting, only a person with an account on your Federated Core can start a Jitsi meeting.
+As of today, Jitsi is the one service in Federated Core that does not use your email address for log. If you email address, for example, is “david@rewind.com”, your Jitsi username would be “david”. Your password is the same as other Federated Core services.
+Username: name without your domain name. +Password: your password.
+Starting A Meeting
+Simply go to the Jitsi application on your Federated Core. You start a meeting by giving it a name.
+ + + + + + + + + +++Tip: these names can “persist”, so you can treat them like “conference rooms” and re-use them over-and-over. For example, name your meeting “customerservice” and then the URL “https://jitsi.domain.com/customerservice" (where “domain.com” is your domain name) can be accessed easily, posted somewhere for later reference/use, etc.
+
You are then asked for the name you want to use for the meeting. This can be whatever you want.
+ + + + + + + + + +You may be asked if you are the “host” for the meeting. Click “I am the host.”
+ + + + + + + + + +Then you will be asked to authenticate so that just anyone off the internet can’t use your Federated Core for meeting.
+ + + + + + + + + +As stated above, your user name will be the part before the “@” symbol in your Federated Core email address. This is the only service, currently, on Federated Core that works this way. Your password is your password.
+Official Jitsi User Documentation
+Here is the official Jitsi user documentation.
Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.
This is the section landing page.
Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.
This is the section landing page.
Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.
This is the section landing page.
Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.
This is the section landing page.
Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.
This is the section landing page.
Federated Core is an easy-to-use, integrated suite of software. You use the Panel application to set up user accounts and these user accounts, for the most part, use their email and password to log into all other services.
-Please read the “Welcome to Federated Core” page for a detailed listing of services and the easy way to use each of them.
+Federated Core is an easy-to-use, integrated suite of software.
+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.
+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.
+https://support.federated.computer
+Phone: 415-779-3333
+Email: support@federated.computer
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,
+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
+
++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.
+
Here are some quick pointers…
+++Note: Replace {domain.com} with the information you used when registering for the service.
+
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}”
+
You should log into “Panel” (see next section) and change the password.
+Panel
+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.
+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/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.
+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 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.
+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.
+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.
+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.
+VPN/Wireguard
+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 +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/vpn.
+++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.
+
++Phone: 415-779-5431
+
++Email: support@federated.computer
+
It’s your computer. Let’s make it work for you!
+ + + + +