Federated Docs – Core Applications

Docs: Baserow

Tue, 30 May 2023 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.

Configuring Users for Baserow

The users for Baserow are not integrated with your Federated Core user management system. You will need to create users and permissions for those users wanting to use Baserow. In this way, you can give users outside your domain access to Baserow applications without giving them access and permissions to your other sensitive data on your Federated Core.

Using your administrative user account, log into Baserow.

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.

Docs: Panel

Tue, 30 May 2023 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Panel is at: https://panel.domain.com where “domain.com” is your domain name.

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.

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.

Once logged into Panel, you can create a user:

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.

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.

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:

Docs: PowerDNS

Tue, 30 May 2023 00:00:00 +0000

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.

Note: this service is restricted to the administrative user for your Federated Core.

Username: admin Password: password for the admin user.

Click on you domain and then add an “A” record to add additional sub-domains.

PowerDNS Support Guide.

Docs: Wireguard

Tue, 30 May 2023 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Wireguard is entirely through the Wireguard application on your desktop computer or mobile device.

Please look at the Wireguard section of Client Applications of the documentation for information on different types of supported devices.

You will need to have the “tunnel” information for your Wireguard service. It is provided to you when your Federated Core is installed.

Note for administrators: you can save the Wireguard tunnel information in a file and distribute that to your users.

Note: please save the file as a “.conf” file so that it is recognized by the Wireguard client software.

Suggestion: use the format “wg0.conf” for your Wireguard file. You can then email this file to all your users.

Docs: Element

Thu, 05 Jan 2017 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Element is at: https://element.domain.com where “domain.com” is your domain name.

Logging into Element

Your Element credentials are as follows:

Homeserver: https://matrix.domain.com where “domain.com” is your domain name.
Username: your email address for your Federated Core
Password: your password for your Federated Core

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 created in “Panel” (with the exception of Listmonk, Vaultwarden, Baserow, Gitea).

Click the “Sign In” buttton.

Your Matrix server should be automatically filled in for the “Homeserver”.

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 “federate” 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 asked how you want to save it.

It is VERY important that you save this key in 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.

Docs: Gitea

Thu, 05 Jan 2017 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Gitea is at: https://gitea.domain.com where “domain.com” is your domain name.

The Gitea service on your Federated Core allows you to manage code repositories just like a service such as Github, but also publish a website, documentation, and a blog.

Setting Up Gitea Users

Publishing Websites Using Gitea

Docs: Jitsi

Thu, 05 Jan 2017 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

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 and 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 in. If your 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.

Docs: Listmonk

Thu, 05 Jan 2017 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.

This is the section landing page.

Docs: Nextcloud

Thu, 05 Jan 2017 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Nextcloud is at: https://nextcloud.domain.com where “domain.com” is your domain name.

Nextcloud provides a rich set of groupware solutions for your team. It is comprised of some key core-applications and can be extended by the administrative user.

The purpose of this document is not to provide documentation on Nextcloud or the Nextcloud applications, but to provide tips about your Federated Core installation of Nextcloud.

Warnings for the Administrative User*

Note: if you sign into Nextcloud as your administrative user, it is possible to compromise and destroy the installation. We hope to correct this in future versions of Federated Core. However, we wanted to provide you with the flexibility to theme Nextcloud, change certain behaviors, messages, etc.

Warning: do NOT change the LDAP/AD Integration settings. This will disconnect your Nextcloud installation from your Federated Core user management features.

Note: users are NOT created in Nextcloud, they are create in Panel so that those user accounts are available to other applications and service on your Federated Core.

A brief overview of the Nextcloud applications.

Dashboard

The dashboard application gives users a quick overview of recent files, any mentions in the Talk application, and a widget for the calendar. You can set your location for the weather (it is a forecast, not current weather), and the ability to customize your dashboard.

Mail

The first time you load the web client for Mail, you will need to accept the “automatic” settings for your mail server. Mail is a full-featured webmail client. Each message can be tagged, an event can be created from the message (using the “triple dot” menu).

Calendar

In Calendar you will see your personal calendar and any calendars for “decks” (project management). There is also functionality for “Appointments” allowing you to set up times that others can schedule time with you.

Contacts

Contacts is your address book for all the people you interact with digitally.

Notes

Notes is a place to write text documents using “text” or “markdown” format (depending on your choice in the “Notes Settings”).

Tip. If you want to share a note with team members or people outside your team/domain, that is done in the “Files” application. Your notes will be found there in the “Notes” folder.

Tasks

A great “to-do” list. You can use this as a list of reminders, another way to do project management, and collaborate with your team.

Files

Works just like Google Drive or Dropbox. However, it has a secret power built in. Client on the big “plus” at the top of the screen to create and edit, in the browser, documents fully compatible with Microsoft Office 365 and Libre Office.

You can install and configure applications for MacOS, Windows, Linux, and the mobile device platforms providing real-time sync of your files across all your devices.

Deck

This is an amazing Kanban-type application for organizing and managing any project. You create columns of “stages” according to your needs across which you can move “task” or “work” cards. You can futher use “tags” to get additional dimensions to your project “tasks”.

Bookmarks

Capture website URLs and organize them into groups.

Forms

Allows you to create simple forms for capturing data from those both inside and outside of your team/domain. For example, want to do a survey, use forms.

Talk

This is a full-featured chat application for your Nextcloud installation. While you also have an industrial-strength chat/communications platform with Element/Matrix, you can use Nextcloud Talk to chat about files, and other objects without Nextcloud itself.

Photos

Duh.

Activity

See what is going on across all the different parts of your Nextcloud installation.

Quick Links to Other Federated Core Services

In the top left corner of the Nextcloud web interface is a icon looking like a grid of squares. Click on the grid to get access to a list of the other services in your Federated Core.

Official Nextcloud User Documentation

For additional information about using Baserow, please consult the user documentation.

Docs: Vaultwarden

Thu, 05 Jan 2017 00:00:00 +0000

This documentation is for users and administrators, not those wanting to install.

Access to Baserow is at: https://baserow.domain.com where “domain.com” is your domain name.

This is the section landing page.