documentation.federated.com.../content/en/docs/getting_started/welcome/_index.md

160 lines
8.3 KiB
Markdown
Raw Permalink Normal View History

2023-06-01 17:23:31 +00:00
---
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.
2023-06-01 16:00:36 +00:00
Dear Federated Customer,
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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:
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
Website: https://support.federated.computer
Phone: 415-779-5431
Email: support@federated.computer
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
We are here to help you, the Customer, get the most out of your Federated Core.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
The information in this document is for the Admin User only. See the documentation pages for information pertinent to users.
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
Here are some quick pointers...
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**[Admin User]**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
There is an "admin" or administrative use that has access to everything on your Federated Core. Here are the credentials for that user.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* Username = "admin@{domain.com}"
* Password = "{password}"
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
You should log into "Panel" (see next section) and change the password.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**Panel: https://panel.{domain.com)**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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).
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
Additional documentation about the Panel service can be found at https://documentation.federated.computer/docs/core_applications/panel.
2023-06-01 17:23:31 +00:00
* Username: admin
* Password: as given above
2023-06-01 16:00:36 +00:00
**[Email]**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* SMTP: Server is "mail.{domain.com}" and the port is "465".
* IMAP: Server is "mail.{domain.com}" and the port is "993".
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**Nextcloud: https://nextcloud.{domain.com}**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* Username: admin@domain.com
* Password: As given above
2023-06-01 16:00:36 +00:00
**Jitsi: https://jitsi.{domain.com}**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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.
2023-06-01 17:23:31 +00:00
* User administration is done in Panel.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**Element: https://element.{domain.com}**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* User administration is done in Panel.
2023-06-01 16:00:36 +00:00
**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:
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
* Listmonk Admin User: listmonk
* Listmonk Admin Password: {}
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**Baserow: https://baserow.{domain.com}**
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* User administration is done in Baserow, but you set up users using the admin user given above.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**Vaultwaden: https://vaultwarden.{domain.com}**
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* User administration is done in Vaultwarden, but you set up users using the admin user given above.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
**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.
2023-06-01 17:23:31 +00:00
* User administration is done in Gitea.
2023-06-01 16:00:36 +00:00
2023-06-01 17:23:31 +00:00
* Gitea Admin User: gitea
* Gitea Admin Password: as given above
2023-06-01 16:00:36 +00:00
**VPN**
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
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:
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
1. VPN Interface
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* Address = {IP}
* PrivateKey = {privatekey}
* ListenPort = 51820
* DNS = {IP}
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
2. VPN Peer
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* PublicKey = {publickey}
* PresharedKey = {presharedkey}
* Endpoint = vpn.{domain.com}:51820
* AllowedIPs = 172.99.0.0/24
2023-06-01 16:00:36 +00:00
Additional information about the VPN service can be found at https://documentation.federated.computer/docs/core_applications/vpn.
2023-05-30 17:55:11 +00:00
2023-06-01 17:23:31 +00:00
* User administration is done in Panel.
2023-05-30 17:55:11 +00:00
2023-06-01 15:38:46 +00:00
**PowerDNS: https://powerdns.{domain.com}**
2023-05-30 17:55:11 +00:00
2023-06-01 15:38:46 +00:00
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.
2023-05-30 17:55:11 +00:00
2023-06-01 15:38:46 +00:00
Additional information about the PowerDNS service can be found at https://documentation.federated.computer/docs/core_applications/powerdns.
2023-05-30 17:55:11 +00:00
2023-06-01 16:00:36 +00:00
Only the admin user has access to this service.
2023-06-01 17:23:31 +00:00
* Username: admin
* Password: as given above
2023-06-01 16:00:36 +00:00
2023-06-01 15:38:46 +00:00
**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.
2023-06-01 17:23:31 +00:00
* Support: https://support.federated.computer
* Phone: 415-779-5431
* Email: support@federated.computer
2023-05-30 17:55:11 +00:00
2023-05-30 23:02:48 +00:00
**It's your computer. Let's make it work for you!**