Refactor source install overview #12472

joshtrichards · 2025-01-03T20:33:48Z

☑️ Resolves

Started as a simple change to clarify the confusing paragraph about "Nextcloud comes with all the required PHP modules". Ended up doing some refactoring and enhancements of the first part of this section because I couldn't help myself. :-)

Tidying / ordering of the existing material
Tried to clarify various bits
Extended info about the various installation methods

P.S. As with anything involving writing, chances are I'll find numerous typos myself tomorrow, but don't hesitate to point out anything you find too.

🖼️ Screenshots

- Document the three bundled (shipped) 2FA providers. - Clarify what "providers" are and why they're important. - Re-order the sections. - Remove some outdated bits. - Eliminate some redundancies. - Misc tidying up. Signed-off-by: Josh <[email protected]>

Signed-off-by: Josh Richards <[email protected]>

MichaIng

Started as a simple change to clarify the confusing paragraph

How most things start 😄. Looks good/much better to me, and did not find typos on a quick read. Only wondering why "Archive" is capitalised in many cases? Indeed I find "Archive-based installation" and "Nextcloud Archive file" like that in two other places of the docs, but would usually write this with lower-case "archive" there as well. However, no real typo.

szaimen

Hi, thanks a lot for the improvements to the documentation! It looks much better already. :)

I had a quick look a the AIO-specific changes and have some suggestions below.

szaimen · 2025-01-06T10:10:41Z

admin_manual/installation/source_installation.rst

+     support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a 
+     `dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best 


Suggested change

support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a

`dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best

support is provided via the `template chooser <https://github.com/nextcloud/all-in-one/issues/new/choose>`_ (on a best

szaimen · 2025-01-06T10:11:18Z

admin_manual/installation/source_installation.rst

+     support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a 
+     `dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best 
+     efforts basis).
+   - For slightly larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement 


Suggested change

- For slightly larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement

- For larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement

szaimen · 2025-01-06T10:14:48Z

admin_manual/installation/source_installation.rst

+   - `Official Documentation <https://github.com/nextcloud/all-in-one>`_ (**Note**: see Official Documentation 
+     for AIO specific installation and usage details).


Suggested change

- `Official Documentation <https://github.com/nextcloud/all-in-one>`_ (**Note**: see Official Documentation

for AIO specific installation and usage details).

- `Official Documentation <https://github.com/nextcloud/all-in-one#nextcloud-all-in-one>`_ (**Note**: see Official Documentation

for AIO specific installation and usage details. You can search through it by using the browser search via `[CTRL]+[F]`). Additional documentation `can be found here <https://github.com/nextcloud/all-in-one/discussions/categories/wiki>`_ .

tflidd · 2025-01-07T01:26:07Z

admin_manual/installation/source_installation.rst

+.. tip:: Optional Nextcloud stack components, such as the in-memory databases and in-memory caching 
+   provided by Redis are useful even in smaller deployments. For this reason they are recommended for
+   all use cases. However, they are not required for initial installation, and  are easy to integrate 
+   afterward when/if desired.


tflidd · 2025-01-07T01:35:55Z

admin_manual/installation/source_installation.rst

+     <https://github.com/nextcloud/vm/?tab=readme-ov-file#server-installation-simplified-cloud>`_.
+   - `Official Documentation <https://github.com/nextcloud/vm/>`_ (**Note**: see Official Documentation 
+     for VM specific installation and usage details).
+* NextcloudPi (aka: NCP)


Perhaps we should mention the extras NCP offers to manage the Linux system to be run in "home networks" (dynDNS, letsencrypt, backup etc.).

I see this as a real advantage for home-users to put a device in their local network. But on a public server, I wouldn't use it.

tflidd · 2025-01-07T01:40:05Z

admin_manual/installation/source_installation.rst

+     and Dockerfile variations. Full feature list available `here <https://github.com/nextcloud/docker/>`_.
+   - `Official Documentation <https://github.com/nextcloud/docker/>`_ (**Note**: see Official Documentation 
+     for Image specific installation and usage details).
+* Nextcloud Web Installer


Perhaps put a bit more "warnings" that this might or might not work, it depends very much on the shared hosting envioronment. On the forum, there is even a howto with some considerations:
https://help.nextcloud.com/t/how-to-get-help-on-shared-webhosting/178243

tflidd · 2025-01-07T01:51:52Z

admin_manual/installation/source_installation.rst

+   - Checks for essential PHP dependencies, downloads the Nextcloud Archive file from the official server, and 
+     unpacks it with the right permissions then directs you to the Nextcloud Server Setup Wizard.
+   - `Official Documentation <https://github.com/nextcloud/web-installer/>`_
+* One Click Signup


You don't really install anything. What must be clear, in contrast to the self-installed versions, you are not in control of these setups. You need to trust these providers as you would have to trust any other cloud-storage provider.
There were examples of providers shutting down service on short notice leaving behind many frustrated users with life-time contracts. And if their service fails, they end up at the Nextcloud community, and ask for help. And there is little guidance to check for "good" service providers. Nextcloud says to select quality providers, but how is this done? I think it would be better to say, what is done that people don't expect too much.

Perhaps it is also a nice way, to have a "look and feel" of Nextcloud and try a bit.

tflidd · 2025-01-07T01:55:00Z

admin_manual/installation/source_installation.rst

+   - Through Simple Signup, getting started is made as easy as possible. You can with the suggested default provider 
+     (based on your location) or choose another.
+   - To sign-up click *Sign up with a provider* `here <https://nextcloud.com/install/#one-click-signup>`_.
+* Nextcloud Enterprise


I would perhaps add the point, to integrate Nextcloud in existing system infrastructure (specific user/storage/authentication backends etc.), which might be more difficult and require more experience than standalone setups.

tflidd · 2025-01-07T02:05:22Z

admin_manual/installation/source_installation.rst

+     all the other benefits that come with `Nextcloud Enterprise <https://nextcloud.com/all-in-one/>`_).
+   - `Official Documentation <https://github.com/nextcloud/all-in-one>`_ (**Note**: see Official Documentation 
+     for AIO specific installation and usage details).
+* Nextcloud Community Snap


I think there was one important limitation, that some configuration cannot be changed (not really sure what it was exactly, like adding new php modules for some apps).

Maybe nextcloud-snap/nextcloud-snap#60?

Yes things like that might be good to know in advance.

szaimen

Some additional suggestions

szaimen · 2025-01-20T16:52:52Z

admin_manual/installation/source_installation.rst

+   - An official installation method that is maintained by `Nextcloud GmbH <https://nextcloud.com/>`_ (the 
+     legal entity that employs many of the most active Nextcloud developers and contributors).
+   - A pre-designed and container-based full Nextcloud stack.
+   - Designed for ease of deployment and maintenance with most features included.
+   - Includes Office, a turnkey Backup solution, Imaginary (for previews of heic, heif, illustrator, 
+     pdf, svg, tiff and webp) and much more (many components are optional). Full feature list available
+     `here <https://github.com/nextcloud/all-in-one?tab=readme-ov-file#nextcloud-all-in-one>`_.
+   - Up to 100 users are free (though without any direct service or support or guarantees). Free community 
+     support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a 
+     `dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best 
+     efforts basis).
+   - For slightly larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement 
+     <https://nextcloud.com/all-in-one/>`_ is required (it includes a support SLA, security information and 
+     all the other benefits that come with `Nextcloud Enterprise <https://nextcloud.com/all-in-one/>`_).


Some additional suggestions:

Suggested change

- An official installation method that is maintained by `Nextcloud GmbH <https://nextcloud.com/>`_ (the

legal entity that employs many of the most active Nextcloud developers and contributors).

- A pre-designed and container-based full Nextcloud stack.

- Designed for ease of deployment and maintenance with most features included.

- Includes Office, a turnkey Backup solution, Imaginary (for previews of heic, heif, illustrator,

pdf, svg, tiff and webp) and much more (many components are optional). Full feature list available

`here <https://github.com/nextcloud/all-in-one?tab=readme-ov-file#nextcloud-all-in-one>`_.

- Up to 100 users are free (though without any direct service or support or guarantees). Free community

support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a

`dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best

efforts basis).

- For slightly larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement

<https://nextcloud.com/all-in-one/>`_ is required (it includes a support SLA, security information and

all the other benefits that come with `Nextcloud Enterprise <https://nextcloud.com/all-in-one/>`_).

- An official installation method that is maintained by `Nextcloud GmbH <https://nextcloud.com/>`_ (the

company behind Nextcloud).

- A pre-designed and container-based full Nextcloud stack.

- Designed for ease of deployment and maintenance with most features included, for tens to hundreds of users.

- Includes Office, a turnkey Backup solution, Imaginary (for previews of heic, heif, illustrator,

pdf, svg, tiff and webp) and much more (many components are optional). Full feature list available

`here <https://github.com/nextcloud/all-in-one?tab=readme-ov-file#nextcloud-all-in-one>`_.

- Free community support is provided via the `template chooser <https://github.com/nextcloud/all-in-one/issues/new/choose>`_ (on a best efforts basis).

- For larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement

<https://nextcloud.com/all-in-one/>`_ is available (it includes a support SLA, security information and

all the other benefits that come with `Nextcloud Enterprise <https://nextcloud.com/all-in-one/>`_).

joshtrichards added 2 commits December 16, 2024 17:52

docs(admin): Source installation guide refactors and enhancements

eff19a2

Signed-off-by: Josh Richards <[email protected]>

joshtrichards added enhancement 3. to review manual: admin feature: install and update labels Jan 3, 2025

joshtrichards requested review from tflidd, MichaIng and szaimen January 3, 2025 20:33

MichaIng approved these changes Jan 4, 2025

View reviewed changes

szaimen requested changes Jan 6, 2025

View reviewed changes

tflidd reviewed Jan 7, 2025

View reviewed changes

szaimen requested changes Jan 20, 2025

View reviewed changes

joshtrichards added 2. developing and removed 3. to review labels Jan 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor source install overview #12472

Refactor source install overview #12472

joshtrichards commented Jan 3, 2025

MichaIng left a comment

szaimen left a comment

szaimen Jan 6, 2025 •

edited

Loading

szaimen Jan 6, 2025

szaimen Jan 6, 2025 •

edited

Loading

tflidd Jan 7, 2025

tflidd Jan 7, 2025

tflidd Jan 7, 2025

tflidd Jan 7, 2025

tflidd Jan 7, 2025

tflidd Jan 7, 2025

szaimen Jan 7, 2025

tflidd Jan 12, 2025

szaimen left a comment

szaimen Jan 20, 2025

		support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a
		`dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best

	support is provided via the `Nextcloud Community Help Forum <https://help.nextcloud.com/>`_ and a
	`dedicated GitHub Discussions area <https://github.com/nextcloud/all-in-one/discussions>`_ (on a best
	support is provided via the `template chooser <https://github.com/nextcloud/all-in-one/issues/new/choose>`_ (on a best

	- For slightly larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement
	- For larger installations (>100 users) an AIO specific `Nextcloud Enterprise arrangement

		- `Official Documentation <https://github.com/nextcloud/all-in-one>`_ (Note: see Official Documentation
		for AIO specific installation and usage details).

Refactor source install overview #12472

Are you sure you want to change the base?

Refactor source install overview #12472

Conversation

joshtrichards commented Jan 3, 2025

☑️ Resolves

🖼️ Screenshots

MichaIng left a comment

Choose a reason for hiding this comment

szaimen left a comment

Choose a reason for hiding this comment

szaimen Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szaimen Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szaimen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szaimen Jan 6, 2025 •

edited

Loading

szaimen Jan 6, 2025 •

edited

Loading