restructure docs

This commit is contained in:
Matt Hill
2023-11-06 12:34:37 -07:00
parent 80651a6609
commit fe79d71e7c
150 changed files with 404 additions and 1866 deletions

View File

@@ -0,0 +1,34 @@
.. _nextcloud-apps:
=============================
Nextcloud Apps & Integrations
=============================
Nextcloud is highly extensible and even has its own `App Store <https://apps.nextcloud.com/>`_. The following guides will help you with the setup, connection, and use of Start9-curated Nextcloud Apps as well as third-party integrations for your server.
Apps
----
.. toctree::
:maxdepth: 1
nc-bookmarks
nc-calendar
nc-contacts
nc-cookbook
nc-files
nc-maps
nc-memories
nc-music
nc-news
nc-notes
nc-photos
Integrations
------------
.. toctree::
:maxdepth: 1
joplin
thunderbird

View File

@@ -0,0 +1,105 @@
.. _nc-joplin:
==================
Joplin Integration
==================
`Joplin <https://joplinapp.org/>`_ is an open source note-taking app. Capture your thoughts and securely access them from any device. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your notes synced.
Clients available for:
- Desktop
- Linux
- Mac
- Windows
- Mobile
- Android
- iOS
Connecting Joplin to Nextcloud (Mac Desktop Example)
----------------------------------------------------
This guide will go over how to connect Joplin running on a desktop machine to your Start9 server's Nextcloud over LAN.
.. note:: This guide assumes your Nextcloud username is "embassy," replace with your username if different.
You will need your device set up to connect via :ref:`LAN<connecting-lan>` first.
#. First go into Nextcloud on your server and click on the "Files" app icon.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup0.png
:width: 30%
:alt: Click on Folders
#. Click on the + icon, then "New folder".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup1.png
:width: 30%
:alt: New Folder
#. Create a new folder called "joplin" and click the arrow to the right.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup3.png
:width: 30%
:alt: Joplin Directory
#. Click on "Files settings" in the bottom left and copy the WebDAV link.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup4.png
:width: 30%
:alt: Files Settings
.. figure:: /_static/images/nextcloud/joplin/joplin-setup5.png
:width: 30%
:alt: WedDAV Link
#. Open up Joplin, click on "Joplin" in the top left and click "Preferences" (on Mac).
.. figure:: /_static/images/nextcloud/joplin/joplin-setup7.png
:width: 30%
:alt: Preferences
#. Click on "Synchronisation".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup8.png
:width: 30%
:alt: Click on Synchronisation
#. Under "Synchronisation target" select "Nextcloud", paste the WebDAV and append onto the end of it "joplin" so the entire URL should look like this (replace ``xxxx`` with your unique Nextcloud LAN address): ``https://xxxx.local/remote.php/dav/files/embassy/joplin``.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup9.png
:width: 30%
:alt: Click on Synchronization
#. Under "Nextcloud username" enter "embassy" (or your username).
#. Under "Nextcloud password" enter your password.
#. The username and password for your Nextcloud can be found in your server's UI by clicking on the Nextcloud service then clicking on "Properties".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup10.png
:width: 30%
:alt: Select Nextcloud and enter URL
.. figure:: /_static/images/nextcloud/joplin/joplin-setup11.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Now click "Show advanced settings".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup12.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Scroll down then check the box that says "Ignore TLS certificate errors".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup13.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Now scroll back up and select "Check sychronisation configuration" and you should see the following success message:
.. figure:: /_static/images/nextcloud/joplin/joplin-setup14.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. You have now connected your Joplin client to your Start9 server's Nextcloud and your notes will sync automatically!

View File

@@ -0,0 +1,46 @@
.. _nc-bookmarks:
===================
Nextcloud Bookmarks
===================
`Nextcloud Bookmarks <https://apps.nextcloud.com/apps/bookmarks>`_ is software for sorting, tagging, searching, sharing, and (most importantly) syncing your browser's bookmarks via your server. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your bookmarks synced.
Clients available for:
- Mobile
- Android
- Desktop Browsers
- Chrome
- Edge
- Firefox
NC App Setup
------------
#. Begin by downloading Bookmarks from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Bookmarks." Click it to get started.
- At this point you can begin adding bookmarks directly into the app, or import them from a browser. These are always available by accessing your Nextcloud from your client devices.
- The real power here is in the ability to import or sync across devices. There are several clients that can accomplish this, which can be found on the `NC Bookmarks Github Page <https://github.com/nextcloud/bookmarks#third-party-clients>`_. For our example, and the recommended option if you click "Sync with your browser" from the Bookmarks welcome page, is `Floccus <https://floccus.org/>`_.
#. (Optional) In the "Settings" menu in the bottom-left, you may change the Nextcloud location in which to store your bookmarks. If you change this or create a new folder, be sure to reflect this change in Floccus below.
Browser & Mobile Setups
-----------------------
Floccus (Browser & Android)
...........................
#. Download the appropriate Floccus extension for your browser or app from the App Store, F-Droid, or Play Store.
#. Open the Floccus browser extension and click "+NEW ACCOUNT", select "Nextcloud Bookmarks", and then add your server address and login via Nextcloud.
#. (Optional) Edit the folder paths if changed above and select a local folder to save bookmarks to.
#. On the final setup page, use the defaults unless you are absolutely sure what you are doing. Click "Continue" and you're ready to sync!
.. note:: Repeat this process for any additional devices or browsers that you'd like to keep in sync.

View File

@@ -0,0 +1,31 @@
.. _nc-calendar:
==================
Nextcloud Calendar
==================
`Nextcloud Calendar <https://apps.nextcloud.com/apps/calendar>`_ is software for managing and syncing calendars, events, and tasks between your devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your calendars synced.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. On the latest Start9 Nextcloud service, Calendar is included by default. If coming from an older install, begin by downloading Calendar from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Calendar." Click it to get started.
- At this point you can begin using the Calendar right away in the web UI. All changes will be reflected in any currently synced client devices, or on any added in future.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

View File

@@ -0,0 +1,31 @@
.. _nc-contacts:
==================
Nextcloud Contacts
==================
`Nextcloud Contacts <https://apps.nextcloud.com/apps/contacts>`_ is software for managing and syncing your contacts between your devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your contacts synced.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. On the latest Start9 Nextcloud service, Contacts is included by default. If coming from an older install, begin by downloading Contacts from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Contacts." There is also a quick access icon in the top-right. Click either to get started.
- At this point you can begin using your Contacts app right away in the WebUI. All changes will be reflected in any currently synced client devices, or on any added in future.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

View File

@@ -0,0 +1,45 @@
.. _nc-cookbook:
==================
Nextcloud Cookbook
==================
`Nextcloud Cookbook <https://apps.nextcloud.com/apps/cookbook>`_ is software for viewing, syncing, and organizing recipes. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your recipes synced.
Clients available for:
- Mobile
- Android
- iOS
NC App Setup
------------
#. Begin by downloading Cookbook from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Cookbook." Click it to get started.
#. You can now start adding recipes. Simply find a recipe online and copy the URL into the box on the left. In most cases, this will be translated into an easy-to-read recipe with ingredients and steps, and without all the distractions and junk included with most recipe pages.
.. tip:: Tag and categorize your recipes! Basic settings are available in the bottom-left menu.
Mobile Setups
-------------
Nextcloud Cookbook (Android / iOS)
..................................
There are 2 versions of this app available on Android, and one on iOS. Check this `repository <https://github.com/nextcloud/cookbook/>`_ for details.
#. Go to your app store of choice and install the Nextcloud Cookbook app.
#. (Android connection) You can select a previously connected Nextcloud account, or scan an app-specific QR, created under Nextcloud's main menu -> Personal Settings -> Security
#. (iOS connection) You will be prompted to enter the following:
- Server URL - get this from your server's Services -> Nextcloud -> Interfaces (LAN is recommended)
- Username - get this from your server's Services -> Nextcloud -> Properties (admin is default)
- Password - get this from your server's Services -> Nextcloud -> Properties
.. note:: You may need to enable "self-signed certificates" for LAN. This is safe to do as you are the signer of the cert and owner of all involved hardware.
#. As soon as you connect and sync, you will see your Cookbook!

View File

@@ -0,0 +1,29 @@
.. _nc-files:
===============
Nextcloud Files
===============
Nextcloud Files is software for managing and syncing your data between your devices. In practice it functions similarly to the file explorer on your computer. Files also serves as the base storage on your server for all the other apps that may need to access your data, such as documents, multimedia, and syncing apps. This even includes data storage for other Start9 services on your server, such as Jellyfin and Start9 Pages.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. You will find an icon in your top menu for "Files." Click here to get started.
- You can begin using your Files app right away in the web UI. All changes will be reflected in any currently synced client devices, or on any added in future.
.. warning:: Keep in mind that if you delete a file in one location, it may be deleted across all locations!! Start with some test folders/files in order to understand how the syncing system works with your devices.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

View File

@@ -0,0 +1,22 @@
.. _nc-maps:
==============
Nextcloud Maps
==============
`Nextcloud Maps <https://apps.nextcloud.com/apps/maps>`_ is software for viewing and managing your places. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your maps synced.
No clients available at this time.
NC App Setup
------------
#. Begin by downloading Maps from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Maps." Click it to get started.
#. You can now browse `OpenStreetMap <https://www.openstreetmap.org/>`_, get directions, create favorite locations, add photos, and share custom maps.
.. tip:: You can find the settings for Maps in the bottom-left
.. note:: This is basic software at this time, havnig just reached 1.0, but features are planned by the developers for linking mobile devices for finding a lost or stolen device as well as fitness tracking and other modern location services.

View File

@@ -0,0 +1,27 @@
.. _nc-memories:
==================
Nextcloud Memories
==================
`Nextcloud Memories <https://apps.nextcloud.com/apps/memories>`_ is software for viewing, managing, and organizing your photos. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your photos synced.
Clients available for:
- Mobile
- Android
NC App Setup
------------
#. Begin by downloading Memories from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Memories." Click it to get started.
#. You will see an image that says "Click Here To Start" - click it and select your media directory.
.. tip:: You can find the settings for Memories under the top-right menu -> Administrative Settings -> Memories
Desktop & Mobile Setups
-----------------------
This is currently a webUI only application, but you can use the same clients as those supported by :ref:`Nextcloud Photos<nc-photos>`.

View File

@@ -0,0 +1,34 @@
.. _nc-music:
===============
Nextcloud Music
===============
`Nextcloud Music <https://apps.nextcloud.com/apps/music>`_ is software for organizing and playing your music as well as managing and streaming podcasts and internet radio. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your music synced.
Clients available for:
- Mobile
- Android
- iOS
- Garmin Watch
- Desktop:
- Linux
- Mac
- Windows
NC App Setup
------------
#. Begin by downloading Music from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Music." Click it to get started.
#. You can now play existing music from your Nextcloud Files, or add an internet radio station or podcast feed!
.. tip:: You can set the media directory path in the 'Settings' menu on the bottom-left
Desktop & Mobile Setups
-----------------------
Nextcloud Music can be used by clients that support Ampache or Subsonic. See all the options in the 'Settings' menu on the bottom-left, or see the `Ampache client list <https://github.com/owncloud/music/wiki/Ampache>`_ or the `Subsonic client list <https://github.com/owncloud/music/wiki/Subsonic>`_.

View File

@@ -0,0 +1,33 @@
.. _nc-news:
==============
Nextcloud News
==============
`Nextcloud News <https://apps.nextcloud.com/apps/news>`_ is software for managing and viewing RSS feeds. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your feeds synced.
Clients available for:
- Mobile
- Android
- iOS
- SailfishOS
- Desktop:
- Linux
- Mac
- Windows
- Unix Terminal
NC App Setup
------------
#. Begin by downloading News from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "News." Click it to get started.
- You can now add your favorite RSS feeds from the left-hand panel.
Desktop & Mobile Setups
-----------------------
Nextcloud News can be synced with a wide range of clients across almost any platform you can imagine. See all the options on the `official client list <https://nextcloud.github.io/news/clients/>`_.

View File

@@ -0,0 +1,49 @@
.. _nc-notes:
===============
Nextcloud Notes
===============
`Nextcloud Notes <https://apps.nextcloud.com/apps/notes>`_ is software for managing and syncing your notes across devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your notes synced.
Clients available for:
- Mobile
- Android
- iOS
- Desktop:
- Unix Terminal
NC App Setup
------------
#. Begin by downloading Notes from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Notes." Click it to get started.
- You can now use the web UI to record your notes.
.. tip:: Markdown is supported
Desktop & Mobile Setups
-----------------------
The real beauty of Notes is being able to sync to your mobile devices for use on the go.
Nextcloud Notes (Android)
.........................
#. Download the Nextcloud Notes app from your favorite app store (Aurora, F-Droid, or Play Store).
#. On the opening screen, select your existing Nextcloud account. If one does not exist, make sure to start with your :ref:`client setup<nextcloud-setup>` or you can hit "Add Account," then create an app passcode QR under Nextcloud's main top-right menu -> Personal Settings -> Hamburger (3 lines) Menu > Security > Devices & Sessions > "Create new app password" and scan it to grant access.
#. You existing notes will now sync, or you can create your first note to test!
Nextcloud Notes (iOS)
.....................
#. Download the Nextcloud Notes app from the App Store.
#. Enter your Nextcloud server URL from your server: Nextcloud -> Interfaces (LAN recommended).
#. You will be redirected and asked for your username and password, both can be found on your server: Nextcloud -> Properties. Then Grant Access.
#. You'll be returned to the setup screen, just tap "Done," your existing notes will now sync, or you can create your first note to test!

View File

@@ -0,0 +1,30 @@
.. _nc-photos:
================
Nextcloud Photos
================
Nextcloud Photos is a basic gallery for viewing and managing your photos. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your photos synced.
Clients available for:
- Mobile
- Android
NC App Setup
------------
#. Photos is included by default and there will be an icon in your top menu for "Photos." Click it and you will be in the web UI viewing your gallery.
Desktop & Mobile Setups
-----------------------
Les Pas (Android)
.................
`Les Pas <https://github.com/scubajeff/lespas>`_ is a great mobile gallery for viewing and organizing your photos, gifs, and videos.
#. First, install Les Pas from your favorite app store (Aurora, F-Droid, or Play Store), or from `the github repository <https://github.com/scubajeff/lespas/releases>`_.
#. At the welcome screen, you will be asked to either enter your server URL or scan a QR code. In your Nextcloud instance, click the top-right menu -> Personal Settings -> Hamburger (3 lines) Menu > Security > Devices & Sessions > "Create new app password." Hit "Show QR Code" and then scan it with Les Pas.
#. You'll be sent to your Nextcloud instance to log in and grant access to the app.
- That's it! You're ready to view your photos with no third party involved!

View File

@@ -0,0 +1,84 @@
.. _nc-thunderbird:
===========
Thunderbird
===========
.. contents::
:depth: 2
:local:
Calendar & Contacts Syncing
===========================
You can set up your devices using their :ref:`integrations<nextcloud-setup>`, but if you wish to use a standalone client for your Calendar and Contacts syncing, we recommend Mozilla's `Thunderbird <https://www.thunderbird.net>`_.
1. Install the :ref:`Calendar<nc-calendar>` and :ref:`Contacts<nc-contacts>` apps in Nextcloud if they are not currently installed.
2. Add your :ref:`RootCA<trust-ca>` to your system and then configure :ref:`Thunderbird<thunderbird>`.
3. Select Calendar or Contacts from below to complete each unique setup:
.. tabs::
.. group-tab:: Calendar
1. In Thunderbird, click on the calendar icon, then "New Address Book" in the bottom-left.
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step1.png
:width: 60%
:alt: thunderbird add calendar
2. Choose "On the network," then click "Next".
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step2.png
:width: 40%
:alt: thunderbird add calendar checkbox
3. Fill in the Username and Location fields with the credentials from Nextcloud > Properties on your Start9 server. Click "Find calendars".
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step3.png
:width: 40%
:alt: thunderbird add calendar checkbox
4. Create a unique app password - In your Nextcloud WebUI, visit the top-right-hand menu and select "Personal Settings" -> "Security." At the bottom, under "Devices & Sessions," create a new app password with a name of your choice, such as "CalDAV." Copy the resulting password and paste it into Thunderbird.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.1.png
:width: 60%
:alt: nextcloud app password
.. figure:: /_static/images/nextcloud/thunderbird-contact-step3.png
:width: 40%
:alt: thunderbird add password
5. Check which calendars you want to integrate and click "Subscribe".
.. figure:: /_static/images/nextcloud/thunderbird-calendar-step5.png
:width: 40%
:alt: thunderbird add calendar subscribe
Your Nextcloud calendar will now sync with Thunderbird. Click on the "Contacts" tab above to add your contacts.
.. group-tab:: Contacts
1. Click on the Address Book icon, open the drop-down menu for "New Address Book" and click "Add CarDav Address Book".
.. figure:: /_static/images/nextcloud/thunderbird-contact-step1.png
:width: 60%
:alt: thunderbird add new contact book
2. Fill in the Username and Location fields with the credentials from Nextcloud > Properties on your Start9 server. Click "Continue".
.. figure:: /_static/images/nextcloud/thunderbird-contact-step2.png
:width: 60%
:alt: thunderbird add new contact book
3. Create a unique app password - In your Nextcloud WebUI, visit the top-right-hand menu and select "Personal Settings" -> "Security." At the bottom, under "Devices & Sessions," create a new app password with a name of your choice, such as "CalDAV." Copy the resulting password and paste it into Thunderbird.
.. figure:: /_static/images/nextcloud/native-nextcloud-integration-macos-step3.1.png
:width: 60%
:alt: nextcloud app password
.. figure:: /_static/images/nextcloud/thunderbird-contact-step3.png
:width: 40%
:alt: thunderbird add password
Your Nextcloud contacts will now sync with Thunderbird.