Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions admin_manual/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# ownCloud Documentation documentation build configuration file, created by
# Nextcloud Documentation documentation build configuration file, created by
# sphinx-quickstart on Mon Oct 22 23:16:40 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
Expand Down Expand Up @@ -282,5 +282,3 @@

# Include todos?
todo_include_todos = True


46 changes: 23 additions & 23 deletions admin_manual/installation/apps_management_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Installing and Managing Apps
============================

After installing Nextcloud, you may provide added functionality by installing
After installing Nextcloud, you may provide added functionality by installing
applications.

Supported Apps
Expand All @@ -13,58 +13,58 @@ See :doc:`apps_supported` for a list of supported Enterprise edition apps.
Viewing Enabled Apps
--------------------

During the Nextcloud installation, some apps are enabled by default. To see which
During the Nextcloud installation, some apps are enabled by default. To see which
apps are enabled go to your Apps page.

.. figure:: ../images/oc_admin_app_page.png
:alt: Apps page for enabling and disabling apps.

You will see which apps are enabled, not enabled, and recommended. You'll also
see additional filters, such as Multimedia, Productivity, and Tool for finding
You will see which apps are enabled, not enabled, and recommended. You'll also
see additional filters, such as Multimedia, Productivity, and Tool for finding
more apps quickly.

Managing Apps
-------------

In the Apps page you can enable or disable applications. Some apps have
configurable options on the Apps page, such as **Enable only for specific
groups**, but mainly they are enabled or disabled here, and are configured on
In the Apps page you can enable or disable applications. Some apps have
configurable options on the Apps page, such as **Enable only for specific
groups**, but mainly they are enabled or disabled here, and are configured on
your Nextcloud Admin page, Personal page, or in ``config.php``.

Adding Third Party Apps
-----------------------

Some apps are developed and supported by Nextcloud directly. These have an
**Official** tag. Apps with the **Approved** tag are community-developed and
supported; they are maintained by trusted developers, and are under active
development. Only **Official** and **Approved** apps are linked on the Apps
Some apps are developed and supported by Nextcloud directly. These have an
**Official** tag. Apps with the **Approved** tag are community-developed and
supported; they are maintained by trusted developers, and are under active
development. Only **Official** and **Approved** apps are linked on the Apps
page by default.

Click the app name to view a description of the app and any of the app settings in the Application View field. Clicking the **Enable** button will enable the app. If the app is not part of the Nextcloud installation, it will be downloaded from the app store, installed and enabled.
Click the app name to view a description of the app and any of the app settings in the Application View field. Clicking the **Enable** button will enable the app. If the app is not part of the Nextcloud installation, it will be downloaded from the app store, installed and enabled.

Click the gear icon on the lower left to browse experimental apps in the `ownCloud Apps
Store <https://apps.owncloud.com/>`_. Install experimental apps at your own risk.

Sometimes the installation of a third-party app fails silently, possibly because
``'appcodechecker' => true,`` is enabled in ``config.php``. When ``appcodechecker`` is
enabled it checks if third-party apps are using the private API, rather than the public
``'appcodechecker' => true,`` is enabled in ``config.php``. When ``appcodechecker`` is
enabled it checks if third-party apps are using the private API, rather than the public
API. If they are then they will not be installed.

.. note:: If you would like to create or add your own Nextcloud app, please
.. note:: If you would like to create or add your own Nextcloud app, please
refer to the `developer manual
<https://docs.nextcloud.org/server/10/developer_manual/app/index.html>`_.

Using Custom App Directories
----------------------------

Use the **apps_paths** array in ``config.php`` to set any custom apps directory
locations. The key **path** defines the absolute file system path to the app
folder. The key **url** defines the HTTP web path to that folder, starting at
the Nextcloud web root. The key **writable** indicates if a user can install apps
Use the **apps_paths** array in ``config.php`` to set any custom apps directory
locations. The key **path** defines the absolute file system path to the app
folder. The key **url** defines the HTTP web path to that folder, starting at
the Nextcloud web root. The key **writable** indicates if a user can install apps
in that folder.

.. note:: To ensure that the default **/apps/** folder only contains apps
shipped with Nextcloud, follow this example to setup an **/apps2/** folder
.. note:: To ensure that the default **/apps/** folder only contains apps
shipped with Nextcloud, follow this example to setup an **/apps2/** folder
which will be used to store all other apps.

::
Expand All @@ -87,7 +87,7 @@ in that folder.
Using Your Own Appstore
-----------------------

You can enable the installation of apps from your own apps store. This requires that you
You can enable the installation of apps from your own apps store. This requires that you
can write to at least one of the configured apps directories.

To enable installation from your own apps store:
Expand All @@ -98,7 +98,7 @@ To enable installation from your own apps store:

2. Set the **appstoreurl** to the URL of your Nextcloud apps store.

This parameter is used to set the http path to the Nextcloud apps store. The appstore
This parameter is used to set the http path to the Nextcloud apps store. The appstore
server must use :abbr:`OCS (Open Collaboration Services)`.

::
Expand Down
80 changes: 40 additions & 40 deletions admin_manual/issues/code_signing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
Code Signing
============

.. sectionauthor:: Lukas Reschke <lukas@owncloud.com>
.. sectionauthor:: Lukas Reschke <lukas@nextcloud.com>
.. _code_signing_label:

Nextcloud supports code signing for the core releases, and for Nextcloud
applications. Code signing gives our users an additional layer of security by
Nextcloud supports code signing for the core releases, and for Nextcloud
applications. Code signing gives our users an additional layer of security by
ensuring that nobody other than authorized persons can push updates.

It also ensures that all upgrades have been executed properly, so that no files
are left behind, and all old files are properly replaced. In the past, invalid
It also ensures that all upgrades have been executed properly, so that no files
are left behind, and all old files are properly replaced. In the past, invalid
updates were a significant source of errors when updating Nextcloud.

FAQ
Expand All @@ -19,51 +19,51 @@ FAQ
Why Did Nextcloud Add Code Signing?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

By supporting Code Signing we add another layer of security by ensuring that
nobody other than authorized persons can push updates for applications, and
By supporting Code Signing we add another layer of security by ensuring that
nobody other than authorized persons can push updates for applications, and
ensuring proper upgrades.

Do We Lock Down Nextcloud?
^^^^^^^^^^^^^^^^^^^^^^^^^^

The Nextcloud project is open source and always will be. We do not want to
make it more difficult for our users to run Nextcloud. Any code signing errors on
upgrades will not prevent Nextcloud from running, but will display a warning on
the Admin page. For applications that are not tagged "Official" the code signing
The Nextcloud project is open source and always will be. We do not want to
make it more difficult for our users to run Nextcloud. Any code signing errors on
upgrades will not prevent Nextcloud from running, but will display a warning on
the Admin page. For applications that are not tagged "Official" the code signing
process is optional.

Not Open Source Anymore?
^^^^^^^^^^^^^^^^^^^^^^^^

The Nextcloud project is open source and always will be. The code signing
process is optional, though highly recommended. The code check for the
core parts of Nextcloud is enabled when the Nextcloud release version branch has
The Nextcloud project is open source and always will be. The code signing
process is optional, though highly recommended. The code check for the
core parts of Nextcloud is enabled when the Nextcloud release version branch has
been set to stable.

For custom distributions of Nextcloud it is recommended to change the release
For custom distributions of Nextcloud it is recommended to change the release
version branch in version.php to something else than "stable".

Is Code Signing Mandatory For Apps?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Code signing is optional for all third-party applications. Applications
Code signing is optional for all third-party applications. Applications
with a tag of "Official" on apps.owncloud.com require code signing.

.. _code_signing_fix_warning_label:

Fixing Invalid Code Integrity Messages
--------------------------------------

A code integrity error message ("There were problems with the code integrity
check. More information…") appears in a yellow banner at the top of your
A code integrity error message ("There were problems with the code integrity
check. More information…") appears in a yellow banner at the top of your
Nextcloud Web interface:

.. image:: images/code-integrity-notification.png
:alt: Code integrity warning banner.

.. note:: The yellow banner is only shown for admin users.

Clicking on this link will take you to your Nextcloud admin page, which provides
Clicking on this link will take you to your Nextcloud admin page, which provides
the following options:

1. Link to this documentation entry.
Expand All @@ -73,8 +73,8 @@ the following options:
.. image:: images/code-integrity-admin.png
:alt: Links for resolving code integrity warnings.

To debug issues caused by the code integrity check click on "List of invalid
files...", and you will be shown a text document listing the different issues. The
To debug issues caused by the code integrity check click on "List of invalid
files...", and you will be shown a text document listing the different issues. The
content of the file will look similar to the following example:

::
Expand Down Expand Up @@ -108,23 +108,23 @@ content of the file will look similar to the following example:
(
[/index.php] => Array
(
[expected] =>
[expected] =>
f1c5e2630d784bc9cb02d5a28f55d6f24d06dae2a0fee685f3
c2521b050955d9d452769f61454c9ddfa9c308146ade10546c
fa829794448eaffbc9a04a29d216
[current] =>
[current] =>
ce08bf30bcbb879a18b49239a9bec6b8702f52452f88a9d321
42cad8d2494d5735e6bfa0d8642b2762c62ca5be49f9bf4ec2
31d4a230559d4f3e2c471d3ea094
)

[/version.php] => Array
(
[expected] =>
[expected] =>
c5a03bacae8dedf8b239997901ba1fffd2fe51271d13a00cc4
b34b09cca5176397a89fc27381cbb1f72855fa18b69b6f87d7
d5685c3b45aee373b09be54742ea
[current] =>
[current] =>
88a3a92c11db91dec1ac3be0e1c87f862c95ba6ffaaaa3f2c3
b8f682187c66f07af3a3b557a868342ef4a271218fe1c1e300
c478e6c156c5955ed53c40d06585
Expand All @@ -137,7 +137,7 @@ content of the file will look similar to the following example:
[/test.php] => Array
(
[expected] =>
[current] =>
[current] =>
09563164f9904a837f9ca0b5f626db56c838e5098e0ccc1d8b
935f68fa03a25c5ec6f6b2d9e44a868e8b85764dafd1605522
b4af8db0ae269d73432e9a01e63a
Expand All @@ -162,7 +162,7 @@ content of the file will look similar to the following example:

In above error output it can be seen that:

1. In the Nextcloud core (that is, the Nextcloud server itself) the files
1. In the Nextcloud core (that is, the Nextcloud server itself) the files
"index.php" and "version.php" do have the wrong version.
2. In the Nextcloud core the unrequired extra file "/test.php" has been found.
3. It was not possible to verify the signature of the calendar application.
Expand All @@ -175,18 +175,18 @@ https://nextcloud.com/support/. After fixing these problems verify by clicking

.. note:: When using a FTP client to upload those files make sure it is using the
``Binary`` transfer mode instead of the ``ASCII`` transfer mode.
.. _rescans_label:

.. _rescans_label:

Rescans
-------

Rescans are triggered at installation, and by updates. You may run scans manually with the ``occ`` command. The first command scans the Nextcloud server files, and the second command scans the named app. There is not yet a command to manually scan all apps::

occ integrity:check-core
occ integrity:check-app $appid
See :doc:`../configuration_server/occ_command` to learn more about using ``occ``.

See :doc:`../configuration_server/occ_command` to learn more about using ``occ``.

Errors
------
Expand All @@ -198,18 +198,18 @@ The following errors can be encountered when trying to verify a code signature.
- ``INVALID_HASH``

- The file has a different hash than specified within ``signature.json``. This
usually happens when the file has been modified after writing the signature
usually happens when the file has been modified after writing the signature
data.

- ``MISSING_FILE``

- The file cannot be found but has been specified within ``signature.json``.
Either a required file has been left out, or ``signature.json`` needs to be
- The file cannot be found but has been specified within ``signature.json``.
Either a required file has been left out, or ``signature.json`` needs to be
edited.

- ``EXTRA_FILE``

- The file does not exist in ``signature.json``. This usually happens when a
- The file does not exist in ``signature.json``. This usually happens when a
file has been removed and ``signature.json`` has not been updated. It also
happens if you have placed additional files in your Nextcloud installation
folder.
Expand All @@ -221,18 +221,18 @@ The following errors can be encountered when trying to verify a code signature.

- ``Signature data not found.```

- The app has mandatory code signing enforced but no ``signature.json``
- The app has mandatory code signing enforced but no ``signature.json``
file has been found in its ``appinfo`` folder.

- ``Certificate is not valid.``

- The certificate has not been issued by the official Nextcloud Code
- The certificate has not been issued by the official Nextcloud Code
Signing Root Authority.

- ``Certificate is not valid for required scope. (Requested: %s, current: %s)``

- The certificate is not valid for the defined application. Certificates
are only valid for the defined app identifier and cannot be used for
- The certificate is not valid for the defined application. Certificates
are only valid for the defined app identifier and cannot be used for
others.

- ``Signature could not get verified.``
Expand Down
16 changes: 8 additions & 8 deletions admin_manual/maintenance/restore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,35 @@
Restoring Nextcloud
===================

To restore a Nextcloud installation there are four main things you need to
To restore a Nextcloud installation there are four main things you need to
restore:

#. The configuration directory
#. The data directory
#. The database
#. The theme directory

.. note:: You must have both the database and data directory. You cannot
.. note:: You must have both the database and data directory. You cannot
complete restoration unless you have both of these.

When you have completed your restoration, see the ``Setting Strong Directory
When you have completed your restoration, see the ``Setting Strong Directory
Permissions`` section of :doc:`../installation/installation_wizard`.

Restore Folders
---------------

.. note:: This guide assumes that your previous backup is called
"owncloud-dirbkp"
.. note:: This guide assumes that your previous backup is called
"nextcloud-dirbkp"

Simply copy your configuration and data folder (or even your whole Nextcloud
Simply copy your configuration and data folder (or even your whole Nextcloud
install and data folder) to your Nextcloud environment. You could use this command::

rsync -Aax nextcloud-dirbkp/ nextcloud/

Restore Database
----------------

.. note:: This guide assumes that your previous backup is called
.. note:: This guide assumes that your previous backup is called
"nextcloud-sqlbkp.bak"

MySQL
Expand All @@ -51,5 +51,5 @@ PostgreSQL
^^^^^^^^^^
::

PGPASSWORD="password" pg_restore -c -d nextcloud -h [server] -U [username]
PGPASSWORD="password" pg_restore -c -d nextcloud -h [server] -U [username]
nextcloud-sqlbkp.bak
Loading