diff --git a/content/en/docs/Core_Applications/Element/_index.md b/content/en/docs/Core_Applications/Element/_index.md index 083998f..55f1f6d 100644 --- a/content/en/docs/Core_Applications/Element/_index.md +++ b/content/en/docs/Core_Applications/Element/_index.md @@ -26,7 +26,7 @@ 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). +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, Gitea). Click the "Sign In" buttton. diff --git a/content/en/docs/Core_Applications/Nextcloud/_index.md b/content/en/docs/Core_Applications/Nextcloud/_index.md index 3ba3d3d..7252ccf 100644 --- a/content/en/docs/Core_Applications/Nextcloud/_index.md +++ b/content/en/docs/Core_Applications/Nextcloud/_index.md @@ -11,7 +11,86 @@ description: > 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 Nextcloud is at: https://nextcloud.domain.com where "domain.com" is your domain name. -This is the section landing page. +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 use, 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 forcast, 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 create 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 synch of your files across all your devices. + +**Deck** + +This is an amazing Kaban-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. + +{{< imgproc mountains Resize "2145x1398" >}} +{{< /imgproc >}} + +**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](https://docs.nextcloud.com/server/latest/user_manual/en/). diff --git a/content/en/docs/Core_Applications/Nextcloud/mountains.jpg b/content/en/docs/Core_Applications/Nextcloud/mountains.jpg new file mode 100644 index 0000000..e2e0d1a Binary files /dev/null and b/content/en/docs/Core_Applications/Nextcloud/mountains.jpg differ diff --git a/content/en/docs/Core_Applications/_index.md b/content/en/docs/Core_Applications/_index.md index 47edd1b..adb47ae 100644 --- a/content/en/docs/Core_Applications/_index.md +++ b/content/en/docs/Core_Applications/_index.md @@ -10,8 +10,6 @@ description: > This documentation is for users and administrators, not those wanting to install. {{% /pageinfo %}} -For many projects, users may not need much information beyond the information in the [Overview](/docs/overview/), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture. - -Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult. +Documentation for each application and service available on Federated Core is listed below. diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/Getting started/_index.md index 68aa2bf..2991d84 100644 --- a/content/en/docs/Getting started/_index.md +++ b/content/en/docs/Getting started/_index.md @@ -12,10 +12,25 @@ This documentation is for users and administrators, not those wanting to install Federated Core is an easy-to-use, integrated suite of software. +**Setting Up User Accounts** + 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. +**Services That Do Not Use Panel for User Accounts** + +A few of the services on your Federated Core do not, currently, use Panel to manage users. This decision was made to allow you to use these services with people outside your domain/team without having to give them access to your email system, etc. The services with user-management outside of Panel are: + +* Baserow +* Listmonk +* Gitea +* Vaultwarden + +**Welcome Document** + 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. +* [Welcome Document](https://documentation.federated.computer/docs/getting-started/welcome/) + **Customer Support** If you have problems setting up your Federated Core, please reach out to customer support for assistance. diff --git a/content/en/docs/Overview/_index.md b/content/en/docs/Overview/_index.md index ecbfc1d..8999775 100644 --- a/content/en/docs/Overview/_index.md +++ b/content/en/docs/Overview/_index.md @@ -13,6 +13,16 @@ This documentation is for users and administrators, not those wanting to install Federated Core is like a Linux distribution in the cloud. It includes a number of leading open-source projects fully integrated so that users don't have to be systems administrators. +**Maintenance and Backup of your Federated Core** + +You don't need to worry about a thing. Your Federated Core is automatically backed up and maintained/updated without your having to do anything. We don't have access to your data, that is all end-to-end encrypted. But you do care for and manage your system so that you can go about doing your business. + +Your backup is stored on B2 cloud storage at [Backblaze](https://www.backblaze.com/b2/cloud-storage.html). In a future version of Federated Core, we will allow you to backup to another provider or mount point. + +**What if More Storage is Needed?** + +Your Federated Core is monitored for storage requirements. If you need more storage, we will reach out to you with inexpensive options for increasing your storage capacity. + ## What is included in this documentation? We have tried to cover the high-level basics of what you will need to know to get the most out of your Federated Core. That includes: diff --git a/public/docs/core_applications/element/index.html b/public/docs/core_applications/element/index.html index ca38b96..d4271d0 100644 --- a/public/docs/core_applications/element/index.html +++ b/public/docs/core_applications/element/index.html @@ -330,7 +330,7 @@ -

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).

+

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, Gitea).

Click the “Sign In” buttton.

diff --git a/public/docs/core_applications/index.html b/public/docs/core_applications/index.html index 61d2b0a..c974da9 100644 --- a/public/docs/core_applications/index.html +++ b/public/docs/core_applications/index.html @@ -301,8 +301,7 @@ -

For many projects, users may not need much information beyond the information in the Overview, so this section is optional. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.

-

Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.

+

Documentation for each application and service available on Federated Core is listed below.

diff --git a/public/docs/core_applications/index.xml b/public/docs/core_applications/index.xml index 4013dae..b2f193a 100644 --- a/public/docs/core_applications/index.xml +++ b/public/docs/core_applications/index.xml @@ -120,7 +120,7 @@ </figure> -<p>Even though there is an option for &ldquo;Create Account&rdquo;, new accounts are turned off so that random folks from the internet can&rsquo;t get onto your server. Accounts for Federated Core are create in &ldquo;Panel&rdquo; (with the exception of Listmonk, Vaultwarden, Baserow).</p> +<p>Even though there is an option for &ldquo;Create Account&rdquo;, new accounts are turned off so that random folks from the internet can&rsquo;t get onto your server. Accounts for Federated Core are create in &ldquo;Panel&rdquo; (with the exception of Listmonk, Vaultwarden, Baserow, Gitea).</p> <p>Click the &ldquo;Sign In&rdquo; buttton.</p> @@ -400,8 +400,71 @@ Password: your password.</p> </div> -<p>Access to Baserow is at: <a href="https://baserow.domain.com">https://baserow.domain.com</a> where &ldquo;domain.com&rdquo; is your domain name.</p> -<p>This is the section landing page.</p> +<p>Access to Nextcloud is at: <a href="https://nextcloud.domain.com">https://nextcloud.domain.com</a> where &ldquo;domain.com&rdquo; is your domain name.</p> +<p>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.</p> +<p>The purpose of this document is <em>not</em> to provide documentation on Nextcloud or the Nextcloud applications, but to provide tips about your Federated Core installation of Nextcloud.</p> +<p><strong>Warnings for the Administrative User</strong>*</p> +<blockquote> +<p>Note: if you sign into Nextcloud as your administrative use, 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.</p> +</blockquote> +<blockquote> +<p>Warning: do NOT change the LDAP/AD Integration settings. This will disconnect your Nextcloud installation from your Federated Core user management features.</p> +</blockquote> +<blockquote> +<p>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.</p> +</blockquote> +<p>A brief overview of the Nextcloud applications.</p> +<p><strong>Dashboard</strong></p> +<p>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 forcast, not current weather), and the ability to customize your dashboard.</p> +<p><strong>Mail</strong></p> +<p>The first time you load the web client for Mail, you will need to accept the &ldquo;automatic&rdquo; settings for your mail server. Mail is a full-featured webmail client. Each message can be tagged, an event can be create from the message (using the &ldquo;triple dot&rdquo; menu).</p> +<p><strong>Calendar</strong></p> +<p>In Calendar you will see your personal calendar and any calendars for &ldquo;decks&rdquo; (project management). There is also functionality for &ldquo;Appointments&rdquo; allowing you to set up times that others can schedule time with you.</p> +<p><strong>Contacts</strong></p> +<p>Contacts is your address book for all the people you interact with digitally.</p> +<p><strong>Notes</strong></p> +<p>Notes is a place to write text documents using &ldquo;text&rdquo; or &ldquo;markdown&rdquo; format (depending on your choice in the &ldquo;Notes Settings&rdquo;).</p> +<blockquote> +<p>Tip. If you want to share a note with team members or people outside your team/domain, that is done in the &ldquo;Files&rdquo; application. Your notes will be found there in the &ldquo;Notes&rdquo; folder.</p> +</blockquote> +<p><strong>Tasks</strong></p> +<p>A great &ldquo;to-do&rdquo; list. You can use this as a list of reminders, another way to do project management, and collaborate with your team.</p> +<p><strong>Files</strong></p> +<p>Works just like Google Drive or Dropbox. HOwever, it has a secret power built in. Client on the big &ldquo;plus&rdquo; at the top of the screen to create and edit, in the browser, documents fully compatible with Microsoft Office 365 and Libre Office.</p> +<p>You can install and configure applications for MacOS, Windows, Linux, and the mobile device platforms providing real-time synch of your files across all your devices.</p> +<p><strong>Deck</strong></p> +<p>This is an amazing Kaban-type application for organizing and managing any project. You create columns of &ldquo;stages&rdquo; according to your needs across which you can move &ldquo;task&rdquo; or &ldquo;work&rdquo; cards. You can futher use &ldquo;tags&rdquo; to get additional dimensions to your project &ldquo;tasks&rdquo;.</p> +<p><strong>Bookmarks</strong></p> +<p>Capture website URLs and organize them into groups.</p> +<p><strong>Forms</strong></p> +<p>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.</p> +<p><strong>Talk</strong></p> +<p>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.</p> +<p><strong>Photos</strong></p> +<p>Duh.</p> + + + + + + + +<figure class="card rounded p-2 td-post-card mb-4 mt-4" style="max-width: 2155px"> + <img class="card-img-top" src="/docs/core_applications/nextcloud/mountains_hu8565b7a34ca6627a5cd63a5e836fe2f7_586983_2145x1398_resize_q75_catmullrom.jpg" width="2145" height="1398"> + + <figcaption class="card-body px-0 pt-2 pb-0"> + <p class="card-text"> +</p> + </figcaption> + +</figure> + +<p><strong>Activity</strong></p> +<p>See what is going on across all the different parts of your Nextcloud installation.</p> +<p><strong>Quick Links to Other Federated Core Services</strong></p> +<p>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.</p> +<p><strong>Official Nextcloud User Documentation</strong></p> +<p>For additional information about using Baserow, please consult the <a href="https://docs.nextcloud.com/server/latest/user_manual/en/">user documentation</a>.</p> diff --git a/public/docs/core_applications/nextcloud/index.html b/public/docs/core_applications/nextcloud/index.html index 8af566d..d48960b 100644 --- a/public/docs/core_applications/nextcloud/index.html +++ b/public/docs/core_applications/nextcloud/index.html @@ -304,8 +304,71 @@
-

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

-

This is the section landing page.

+

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 use, 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 forcast, 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 create 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 synch of your files across all your devices.

+

Deck

+

This is an amazing Kaban-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.

diff --git a/public/docs/core_applications/nextcloud/mountains.jpg b/public/docs/core_applications/nextcloud/mountains.jpg new file mode 100644 index 0000000..e2e0d1a Binary files /dev/null and b/public/docs/core_applications/nextcloud/mountains.jpg differ diff --git a/public/docs/core_applications/nextcloud/mountains_hu8565b7a34ca6627a5cd63a5e836fe2f7_586983_2145x1398_resize_q75_catmullrom.jpg b/public/docs/core_applications/nextcloud/mountains_hu8565b7a34ca6627a5cd63a5e836fe2f7_586983_2145x1398_resize_q75_catmullrom.jpg new file mode 100644 index 0000000..3ede640 Binary files /dev/null and b/public/docs/core_applications/nextcloud/mountains_hu8565b7a34ca6627a5cd63a5e836fe2f7_586983_2145x1398_resize_q75_catmullrom.jpg differ diff --git a/public/docs/getting-started/index.html b/public/docs/getting-started/index.html index 206ce5b..1f81ce9 100644 --- a/public/docs/getting-started/index.html +++ b/public/docs/getting-started/index.html @@ -302,8 +302,21 @@

Federated Core is an easy-to-use, integrated suite of software.

+

Setting Up User Accounts

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.

+

Services That Do Not Use Panel for User Accounts

+

A few of the services on your Federated Core do not, currently, use Panel to manage users. This decision was made to allow you to use these services with people outside your domain/team without having to give them access to your email system, etc. The services with user-management outside of Panel are:

+ +

Welcome Document

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

diff --git a/public/docs/overview/index.html b/public/docs/overview/index.html index a6d15d8..cef5875 100644 --- a/public/docs/overview/index.html +++ b/public/docs/overview/index.html @@ -310,6 +310,11 @@

Federated Core is like a Linux distribution in the cloud. It includes a number of leading open-source projects fully integrated so that users don’t have to be systems administrators.

+

Maintenance and Backup of your Federated Core

+

You don’t need to worry about a thing. Your Federated Core is automatically backed up and maintained/updated without your having to do anything. We don’t have access to your data, that is all end-to-end encrypted. But you do care for and manage your system so that you can go about doing your business.

+

Your backup is stored on B2 cloud storage at Backblaze. In a future version of Federated Core, we will allow you to backup to another provider or mount point.

+

What if More Storage is Needed?

+

Your Federated Core is monitored for storage requirements. If you need more storage, we will reach out to you with inexpensive options for increasing your storage capacity.

What is included in this documentation?

We have tried to cover the high-level basics of what you will need to know to get the most out of your Federated Core. That includes: