first commit
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: "Getting started"
|
||||
tagline: "How Federated Core is set up, how you sign in, and where to change settings."
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Federated Core is the collection of open-source applications that Federated Computer installs, runs, and maintains for you. Each customer gets their own virtual machine, and each application on it is installed separately for that customer. You use the applications in a web browser (and, for some, in desktop and mobile apps); Federated Computer handles servers, updates, backups, and security patches.
|
||||
|
||||
Read these guides in order if you are new. They apply to every application in this documentation.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Accounts and signing in"
|
||||
tagline: "One account for your organization's apps, protected by Authelia."
|
||||
weight: 20
|
||||
---
|
||||
|
||||
## One account, many apps
|
||||
|
||||
People in your organization are created once, in Superpanel. That account is stored in a central user directory on your server, and most applications check sign-ins against it. In practice this means:
|
||||
|
||||
- The **same username and password** work across the apps that are connected to the directory.
|
||||
- When someone's password changes, it changes everywhere.
|
||||
- When someone leaves and their account is disabled in Superpanel, they lose access to the connected apps at the same time.
|
||||
|
||||
Many apps also sign you in through [Authelia](/apps/authelia/), the single sign-on portal. When you open one of these apps and aren't signed in yet, you are sent to the Authelia sign-in page first, then returned to the app.
|
||||
|
||||
{{< note title="Some apps keep their own accounts" >}}
|
||||
A few applications are designed for people outside your organization or hold especially sensitive data, so they use separate accounts. Examples include [Vaultwarden](/apps/vaultwarden/) (your password vault has its own master password), and public-facing community or newsletter features in [Discourse](/apps/discourse/) and [Listmonk](/apps/listmonk/). Each application's page says how sign-in works for that app.
|
||||
{{< /note >}}
|
||||
|
||||
## Signing in for the first time
|
||||
|
||||
1. Look for the welcome email from your administrator or from Federated Computer. It contains your username and either a temporary password or a link to set one.
|
||||
2. Open any application address on your domain. If you're sent to the Authelia portal, enter your username and password there.
|
||||
|
||||
{{< screenshot src="authelia/sign-in.png" alt="The Authelia sign-in page with username and password fields" caption="The Authelia sign-in page." >}}
|
||||
|
||||
3. If your organization requires two-factor authentication, Authelia will ask you to register a second factor. See [Set up two-factor authentication](/apps/authelia/#set-up-two-factor-authentication).
|
||||
4. Change any temporary password straight away.
|
||||
|
||||
## Forgotten passwords
|
||||
|
||||
Use the **Reset password** link on the Authelia sign-in page. A reset link is sent to the email address on your account. If you no longer have access to that mailbox, ask an administrator to reset your password in Superpanel.
|
||||
|
||||
## Good habits
|
||||
|
||||
- Turn on two-factor authentication, even if it's optional for your organization.
|
||||
- Store your password in [Vaultwarden](/apps/vaultwarden/) rather than reusing it.
|
||||
- Sign out on shared computers. Signing out of Authelia ends your single sign-on session for all connected apps.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "Command-line access"
|
||||
tagline: "What the Enterprise option adds, and how to get advanced tasks done without it."
|
||||
weight: 40
|
||||
---
|
||||
|
||||
## Standard installations
|
||||
|
||||
On a standard Federated Core installation, you do **not** have shell or SSH access to your virtual machine. You manage everything through:
|
||||
|
||||
- **Superpanel**, for people, groups, application access, and server-level options.
|
||||
- **Each application's own admin screens**, for everything inside the app.
|
||||
|
||||
This covers nearly everything most organizations need. When a task in these guides needs the command line, it's marked like this:
|
||||
|
||||
{{< enterprise >}}
|
||||
This step uses a command run on the server.
|
||||
{{< /enterprise >}}
|
||||
|
||||
If you see that callout and you don't have Enterprise, contact Federated Computer support and describe what you want done. They can run the command for you.
|
||||
|
||||
## Enterprise installations
|
||||
|
||||
If Federated Core was installed using the Enterprise option, your designated administrators also have command-line access to the VM. That makes extra tasks possible, such as:
|
||||
|
||||
- Running application maintenance tools (for example Nextcloud's `occ`, Discourse's Rails console, or Bookstack's `artisan` commands).
|
||||
- Bulk imports and exports that are too large for a web upload.
|
||||
- Inspecting application logs directly.
|
||||
|
||||
{{< warning title="Shared responsibility" >}}
|
||||
Command-line changes can affect updates and backups that Federated Computer performs. Before changing application configuration files or installed versions, check with Federated Computer support so that your change isn't overwritten by the next update.
|
||||
{{< /warning >}}
|
||||
|
||||
Applications on Federated Core run in containers. Commands in these guides that start with an application tool (such as `occ` or `php artisan`) must be run inside that application's container. Federated Computer will tell Enterprise customers how containers are named on their server.
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: "Getting help"
|
||||
tagline: "Where to go when something isn't working or you're not sure how to do something."
|
||||
weight: 50
|
||||
---
|
||||
|
||||
## Start here
|
||||
|
||||
1. **Search this site.** Press <kbd>/</kbd> anywhere to jump to the search box. You can search by app name or by the service you're used to, such as "Dropbox" or "Zoom".
|
||||
2. **Check the application's official documentation.** Every app page links to it. Upstream manuals are detailed and cover features these guides only summarize.
|
||||
3. **Ask your administrator.** Account, password, and access problems are usually solved in Superpanel.
|
||||
|
||||
## Contact Federated Computer support
|
||||
|
||||
Contact support when:
|
||||
|
||||
- An application is down, slow, or showing server errors.
|
||||
- You need a task done that requires the command line and you don't have the Enterprise option.
|
||||
- You want to add an application to your plan.
|
||||
- You think something is wrong with backups, email delivery, or certificates.
|
||||
|
||||
When you write, include the application's address, what you were trying to do, what happened instead, and the time it happened. Screenshots help.
|
||||
|
||||
## Community help
|
||||
|
||||
Each project has its own community forum or chat. These are good places to ask "how do I…" questions about features. Don't post passwords, internal addresses, or customer data in public forums.
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: "How Federated Core works"
|
||||
tagline: "Your own server, your own domain, and open-source applications maintained for you."
|
||||
weight: 10
|
||||
---
|
||||
|
||||
## What you get
|
||||
|
||||
When you sign up, Federated Computer creates a virtual machine (VM) for your organization and installs the applications included in your plan. Each application is installed individually for you. There is no shared, multi-tenant database: your files, messages, and records are stored on your VM.
|
||||
|
||||
Every application is open source. That means:
|
||||
|
||||
- **No per-seat licence fees** to the software vendor. You pay Federated Computer for hosting and maintenance.
|
||||
- **No lock-in.** Data is kept in standard, documented formats, and the same software can run anywhere.
|
||||
- **Upstream documentation applies.** Each app has a large community and its own manual. These guides link to it wherever it helps.
|
||||
|
||||
## Where your applications live
|
||||
|
||||
Each application is published on its own web address under your domain. The address usually follows the pattern `https://appname.yourdomain.com`, for example `https://nextcloud.example.com` or `https://vaultwarden.example.com`. The exact address of every app on your server is listed in Superpanel.
|
||||
|
||||
{{< note title="Bookmark your start page" >}}
|
||||
Save the addresses of the apps you use every day as browser bookmarks, or pin them as installed web apps in Chrome, Edge, or Safari. Several apps (Nextcloud, Element, Vaultwarden, Immich) also have mobile and desktop apps; you will need the address when you first sign in.
|
||||
{{< /note >}}
|
||||
|
||||
## Who does what
|
||||
|
||||
| Task | Who handles it |
|
||||
| --- | --- |
|
||||
| Server hardware, operating system, and networking | Federated Computer |
|
||||
| Installing and updating applications | Federated Computer |
|
||||
| TLS certificates (the padlock in your browser) | Federated Computer |
|
||||
| Backups of the VM | Federated Computer |
|
||||
| Adding people, resetting passwords, assigning access | Your administrators, in Superpanel |
|
||||
| Settings inside each application (branding, workflows, content) | Your administrators, in each app's own admin screens |
|
||||
| Using the applications | Everyone in your organization |
|
||||
|
||||
## Two ways Federated Core can be installed
|
||||
|
||||
Most customers use the **standard** installation. You manage everything through web interfaces: Superpanel, plus each application's own settings pages. You do not have shell (command-line) access to the VM.
|
||||
|
||||
Customers who chose the **Enterprise** option during installation also get command-line access to their VM. Some advanced tasks in these guides (marked with an Enterprise callout) can only be done that way. If you don't have Enterprise and need one of those tasks done, contact Federated Computer support. See [Command-line access](../command-line-access/).
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: "Superpanel"
|
||||
tagline: "The web control panel for your Federated Core server: people, access, and application settings."
|
||||
weight: 30
|
||||
---
|
||||
|
||||
Superpanel is where administrators in your organization manage the Federated Core server without needing the command line. If a task in these guides says "in Superpanel", this is the place.
|
||||
|
||||
{{< review "Menu labels below describe Superpanel's functions in general terms. Confirm wording against the current Superpanel release before publishing." >}}
|
||||
|
||||
## Who can use Superpanel
|
||||
|
||||
Only people your organization has made Superpanel administrators can sign in to it. Everyone else uses the applications directly. If you need something changed and you aren't an administrator, ask one of your administrators or contact Federated Computer support.
|
||||
|
||||
## What you can do in Superpanel
|
||||
|
||||
### Manage people
|
||||
|
||||
- **Add a person.** Enter their name, username, and email address. The account is created in your central directory and becomes available in every connected application.
|
||||
- **Reset a password** for someone who is locked out.
|
||||
- **Disable or remove an account** when someone leaves. Disabling is usually the better first step: the person can no longer sign in, but files and records they own stay in place until you've reassigned them.
|
||||
- **Make someone an administrator** of Superpanel or of individual applications.
|
||||
|
||||
### Manage groups and application access
|
||||
|
||||
Groups let you grant access to several people at once. Typical uses are giving a team access to a particular application, or giving a smaller group administrator rights inside an app. Changes made here apply to the connected applications the next time the person signs in.
|
||||
|
||||
### See and manage applications
|
||||
|
||||
Superpanel lists every application installed on your server, along with its web address. From here, administrators can:
|
||||
|
||||
{{< screenshot src="superpanel/dashboard.png" alt="The Superpanel dashboard showing account and group counts, storage, and installed applications" caption="The Superpanel dashboard. Each application in the sidebar links to its address." >}}
|
||||
|
||||
- Find the address of each application to share with colleagues.
|
||||
- Request or enable an application that is available for your plan but not yet installed.
|
||||
- Change the options Federated Computer exposes for that application, such as whether it is visible to all users or only to certain groups.
|
||||
|
||||
The options available for each application are listed on that application's page in this documentation, under **Superpanel settings**.
|
||||
|
||||
### Domain and email settings
|
||||
|
||||
Federated Core publishes applications on your own domain. Superpanel shows the DNS records your domain needs and, where your plan includes it, lets you manage DNS through [PowerDNS](/apps/powerdns/). If you host your domain's DNS elsewhere, copy the records shown into your DNS provider.
|
||||
|
||||
## Settings that live inside each app
|
||||
|
||||
Superpanel handles accounts, access, and server-level options. Everything else (branding, workflows, content, notification preferences, integrations) is configured in the application itself, usually under a menu called **Settings**, **Administration**, or **Admin**. Each application page in this documentation explains where to find those screens.
|
||||
|
||||
{{< note title="What Superpanel doesn't do" >}}
|
||||
Superpanel doesn't give access to the VM's operating system, files on disk, or application configuration files. Those require command-line access, which is only available with the Enterprise option. For standard installations, Federated Computer support can make those changes for you.
|
||||
{{< /note >}}
|
||||
Reference in New Issue
Block a user