mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-02 17:59:36 +07:00
Merge pull request #524 from nextcloud/make-all
Run all make commands on CI
This commit is contained in:
Morris Jobke
@@ -2,7 +2,4 @@ pipeline:
|
||||
documentation:
|
||||
image: nextcloudci/documentation:1.0.11
|
||||
commands:
|
||||
- (cd user_manual && make html-all)
|
||||
- (cd admin_manual && make html-all)
|
||||
- (cd developer_manual && make html-all)
|
||||
- (cd user_manual_de && make html-all)
|
||||
- make all
|
||||
|
||||
@@ -80,7 +80,7 @@ nginx
|
||||
* `client_body_temp_path <http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_temp_path>`_
|
||||
|
||||
Since nginx 1.7.11 a new config option `fastcgi_request_buffering
|
||||
<https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_request_buffering`_
|
||||
<https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_request_buffering>`_
|
||||
is availabe. Setting this option to ``fastcgi_request_buffering off;`` in your nginx config
|
||||
might help with timeouts during the upload. Furthermore it helps if you're running out of
|
||||
disc space on the tmp partition of your system.
|
||||
|
||||
@@ -1063,10 +1063,6 @@ concerns:
|
||||
- OC\\Preview\\TIFF
|
||||
- OC\\Preview\\Font
|
||||
|
||||
.. note:: Troubleshooting steps for the MS Word previews are available
|
||||
at the :doc:`../configuration_files/collaborative_documents_configuration`
|
||||
section of the Administrators Manual.
|
||||
|
||||
The following providers are not available in Microsoft Windows:
|
||||
|
||||
- OC\\Preview\\Movie
|
||||
@@ -1432,7 +1428,7 @@ and MySQL can handle 4 byte characters instead of 3 byte characters.
|
||||
|
||||
If you want to convert an existing 3-byte setup into a 4-byte setup please
|
||||
set the parameters in MySQL as mentioned below and run the migration command:
|
||||
./occ db:convert-mysql-charset
|
||||
./occ db:convert-mysql-charset
|
||||
The config setting will be set automatically after a successful run.
|
||||
|
||||
Consult the documentation for more details.
|
||||
|
||||
@@ -33,7 +33,7 @@ archive <https://nextcloud.com/install/>`_.
|
||||
.. _vm_label:
|
||||
|
||||
Installing on Windows (Virtual Machine)
|
||||
----------------------------
|
||||
---------------------------------------
|
||||
|
||||
If you are using Windows, the easiest way to get Nextcloud up an running is using our Virtual Machine. The VM is mainly maintainted by Tech and Me and are offered in several different versions. The main version is for VMware version 10 and comes in different sizes. The standard size is 20 GB, but you can also download a 500 GB and a 1 TB version. Tech and Me also provides a Hyper-V version for all Hyper-V users.
|
||||
|
||||
|
||||
@@ -262,7 +262,7 @@ and if running in a subfolder like ``nextcloud``:
|
||||
For the first case the :file:`.htaccess` file shipped with Nextcloud should do
|
||||
this work for your when running Apache. You only need to make sure that your
|
||||
Web server is using this file. When running Nginx please refer to
|
||||
:doc:`../installation/nginx.
|
||||
:doc:`../installation/nginx`.
|
||||
|
||||
|
||||
If your Nextcloud instance is installed in a subfolder called ``nextcloud`` and
|
||||
|
||||
@@ -40,7 +40,7 @@ The build-in updater performs these operations:
|
||||
actions are executed while running the update of the code.
|
||||
* **Create backup:** creates a backup of the existing code base in
|
||||
``/updater-INSTANCEID/backups/nextcloud-CURRENTVERSION/`` inside of the
|
||||
data directory (this does not contain the ``/data``directory nor the
|
||||
data directory (this does not contain the ``/data`` directory nor the
|
||||
database).
|
||||
* **Downloading:** downloads the code in the version it should update to. This
|
||||
is also shown in the web UI before the update is started. This archive is
|
||||
|
||||
@@ -90,7 +90,7 @@ Code example
|
||||
// do your stuff here
|
||||
}
|
||||
}
|
||||
…
|
||||
// …
|
||||
}
|
||||
|
||||
Read folder
|
||||
@@ -121,7 +121,7 @@ Code example
|
||||
// do your stuff here
|
||||
}
|
||||
}
|
||||
…
|
||||
// …
|
||||
}
|
||||
|
||||
Read file
|
||||
@@ -148,7 +148,7 @@ Code example
|
||||
// do your stuff here
|
||||
}
|
||||
}
|
||||
…
|
||||
// …
|
||||
}
|
||||
|
||||
Delete file or folder
|
||||
@@ -174,7 +174,7 @@ Code example
|
||||
// do your stuff here
|
||||
}
|
||||
}
|
||||
…
|
||||
// …
|
||||
}
|
||||
|
||||
|
||||
@@ -279,7 +279,7 @@ Code example
|
||||
// do your stuff here
|
||||
}
|
||||
}
|
||||
…
|
||||
// …
|
||||
}
|
||||
|
||||
Read shared items by link
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _webdavindex:
|
||||
.. _ocsapiindex:
|
||||
|
||||
=========
|
||||
OCS API's
|
||||
@@ -9,9 +9,9 @@ This document provides a quick overview of the OCS API endpoints supported in Ne
|
||||
All requests need to provide authentication information, either as a Basic Auth header or by passing a set of valid session cookies, if not stated otherwise.
|
||||
|
||||
|
||||
----
|
||||
--------------------------
|
||||
Testing requests with curl
|
||||
----
|
||||
--------------------------
|
||||
|
||||
All OCS requests can be easily tested out using :code:`curl` by specifying the request method (:code:`GET`, :code:`PUT`, etc) and setting a request body where needed.
|
||||
|
||||
@@ -66,9 +66,9 @@ This request returns the available metadata of a user. Admin users can see the i
|
||||
</ocs>
|
||||
|
||||
|
||||
----
|
||||
----------------
|
||||
Capabilities API
|
||||
----
|
||||
----------------
|
||||
|
||||
Clients can obtain capabilities provided by the Nextcloud server and its apps via the capabilities OCS API.
|
||||
|
||||
|
||||
@@ -7,17 +7,17 @@ WebDAV Client API's
|
||||
This document provides a quick overview of the WebDAV operations supported in Nextcloud, to keep things readable it won't go into many details
|
||||
for each operation, further information for each operation can be found in the corresponding rfc where applicable
|
||||
|
||||
----
|
||||
-------------
|
||||
WebDAV Basics
|
||||
----
|
||||
-------------
|
||||
|
||||
The base url for all WebDAV operations for a Nextcloud instance is :code:`/remote.php/dav`.
|
||||
|
||||
All requests need to provide authentication information, either as a Basic Auth header or by passing a set of valid session cookies.
|
||||
|
||||
----
|
||||
--------------------------
|
||||
Testing requests with curl
|
||||
----
|
||||
--------------------------
|
||||
|
||||
All WebDAV requests can be easily tested out using :code:`curl` by specifying the request method (:code:`GET`, :code:`PROPFIND`, :code:`PUT`, etc) and setting a request body where needed.
|
||||
|
||||
@@ -39,9 +39,9 @@ For example: you can perform a :code:`PROPFIND` request to find files in a folde
|
||||
</d:propfind>'
|
||||
|
||||
|
||||
----
|
||||
--------------------------
|
||||
Listing Folders (rfc4918_)
|
||||
----
|
||||
--------------------------
|
||||
|
||||
The contents of a folder can be listed by sending a :code:`PROPFIND` request to the folder.
|
||||
|
||||
@@ -49,9 +49,9 @@ The contents of a folder can be listed by sending a :code:`PROPFIND` request to
|
||||
|
||||
PROPFIND remote.php/dav/files/user/path/to/folder
|
||||
|
||||
~~~~
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
Requesting properties
|
||||
~~~~
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
By default, a :code:`PROPFIND` request will only return a small number of properties for each file: last modified date, file size, whether it's a folder, etag and mime type.
|
||||
|
||||
@@ -98,15 +98,15 @@ The following properties are supported:
|
||||
- :code:`{http://owncloud.org/ns}has-preview`
|
||||
- :code:`{http://owncloud.org/ns}size` Unlike :code:`getcontentlength`, this property also works for folders reporting the size of everything in the folder.
|
||||
|
||||
~~~~
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Getting properties for just the folder
|
||||
~~~~
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can request properties of a folder without also getting the folder contents by adding a :code:`Depth: 0` header to the request.
|
||||
|
||||
----
|
||||
-----------------
|
||||
Downloading files
|
||||
----
|
||||
-----------------
|
||||
|
||||
A file can be downloaded by sending a :code:`GET` request to the WebDAV url of the file.
|
||||
|
||||
@@ -114,9 +114,9 @@ A file can be downloaded by sending a :code:`GET` request to the WebDAV url of t
|
||||
|
||||
GET remote.php/dav/files/user/path/to/file
|
||||
|
||||
----
|
||||
---------------
|
||||
Uploading files
|
||||
----
|
||||
---------------
|
||||
|
||||
A file can be uploading by sending a :code:`PUT` request to the file and sending the raw file contents as the request body.
|
||||
|
||||
@@ -126,9 +126,9 @@ A file can be uploading by sending a :code:`PUT` request to the file and sending
|
||||
|
||||
Any existing file will be overwritten by the request.
|
||||
|
||||
----
|
||||
---------------------------
|
||||
Creating folders (rfc4918_)
|
||||
----
|
||||
---------------------------
|
||||
|
||||
A folder can be created by sending a :code:`MKCOL` request to the folder.
|
||||
|
||||
@@ -136,9 +136,9 @@ A folder can be created by sending a :code:`MKCOL` request to the folder.
|
||||
|
||||
MKCOL remote.php/dav/files/user/path/to/new/folder
|
||||
|
||||
----
|
||||
-------------------------------------
|
||||
Deleting files and folders (rfc4918_)
|
||||
----
|
||||
-------------------------------------
|
||||
|
||||
A file or folder can be created by sending a :code:`DELETE` request to the file or folder.
|
||||
|
||||
@@ -148,9 +148,9 @@ A file or folder can be created by sending a :code:`DELETE` request to the file
|
||||
|
||||
When deleting a folder, it's contents will be deleted recursively.
|
||||
|
||||
----
|
||||
-----------------------------------
|
||||
Moving files and folders (rfc4918_)
|
||||
----
|
||||
-----------------------------------
|
||||
|
||||
A file or folder can be moved by sending a :code:`MOVE` request to the file or folder and specifying the destination in the :code:`Destination` header as full url.
|
||||
|
||||
@@ -161,9 +161,9 @@ A file or folder can be moved by sending a :code:`MOVE` request to the file or f
|
||||
|
||||
The overwrite behavior of the move can be controlled by setting the :code:`Overwrite` head to :code:`T` or :code:`F` to enable or disable overwriting respectively.
|
||||
|
||||
----
|
||||
------------------------------------
|
||||
Copying files and folders (rfc4918_)
|
||||
----
|
||||
------------------------------------
|
||||
|
||||
A file or folder can be copied by sending a :code:`COPY` request to the file or folder and specifying the destination in the :code:`Destination` header as full url.
|
||||
|
||||
@@ -174,9 +174,9 @@ A file or folder can be copied by sending a :code:`COPY` request to the file or
|
||||
|
||||
The overwrite behavior of the copy can be controlled by setting the :code:`Overwrite` head to :code:`T` or :code:`F` to enable or disable overwriting respectively.
|
||||
|
||||
----
|
||||
------------------
|
||||
Settings favorites
|
||||
----
|
||||
------------------
|
||||
|
||||
A file or folder can be marked as favorite by sending a :code:`PROPPATCH` request to the file or folder and setting the :code:`oc-favorite` property
|
||||
|
||||
@@ -194,9 +194,9 @@ A file or folder can be marked as favorite by sending a :code:`PROPPATCH` reques
|
||||
|
||||
Setting the :code:`oc:favorite` property to 1 marks a file as favorite, setting it to 0 un-marks it as favorite.
|
||||
|
||||
----
|
||||
-----------------
|
||||
Listing favorites
|
||||
----
|
||||
-----------------
|
||||
|
||||
Favorites for a user can be retrieved by sending a :code:`REPORT` request and specifying :code:`oc:favorite` as a filter
|
||||
|
||||
|
||||
@@ -31,11 +31,11 @@ The most important labels and their meaning:
|
||||
* #needs info - this issue needs further information from the reporter, see :doc:`../bugtracker/triaging`
|
||||
* #high #medium #low signify how important the bug is.
|
||||
* Tags showing the state of the issue or PR, numbered 0-4:
|
||||
* #0 - Needs triage - ready to start development on this
|
||||
* #1 - To develop - ready to start development on this
|
||||
* #2 - Developing - development in progress
|
||||
* #3 - To Review - ready for review
|
||||
* #4 - To Release - reviewed PR that awaits unfreeze of a branch to get merged
|
||||
* #0 - Needs triage - ready to start development on this
|
||||
* #1 - To develop - ready to start development on this
|
||||
* #2 - Developing - development in progress
|
||||
* #3 - To Review - ready for review
|
||||
* #4 - To Release - reviewed PR that awaits unfreeze of a branch to get merged
|
||||
* Feature tags: #feature: something. These tags indicate the features across apps and components which are impacted by the issue or which the PR is related to
|
||||
|
||||
If you want a label not in the list above, please first discuss on the mailing list.
|
||||
|
||||
@@ -21,9 +21,10 @@ Get the source
|
||||
There are two ways to obtain Nextcloud sources:
|
||||
|
||||
* Using the `stable version <https://docs.nextcloud.org/server/12/admin_manual/#installation>`_
|
||||
.. TODO ON RELEASE: Update version number above on release
|
||||
* Using the development version from `GitHub`_ which will be explained below.
|
||||
|
||||
.. TODO ON RELEASE: Update version number above on release
|
||||
|
||||
To check out the source from `GitHub`_ you will need to install Git (see `Setting up Git <https://help.github.com/articles/set-up-git>`_ from the GitHub help)
|
||||
|
||||
Gather information about server setup
|
||||
|
||||
@@ -18,6 +18,7 @@ Its usage is documented separately in the `Nextcloud/ownCloud Desktop Client Man
|
||||
|
||||
.. _`Nextcloud/ownCloud Desktop Client Manual`: https://doc.owncloud.org/desktop/2.2/
|
||||
.. _Nextcloud Desktop Client Manual: https://docs.nextcloud.org/
|
||||
.. _Nextcloud Sync Client: https://nextcloud.com/install/#install-clients
|
||||
|
||||
Mobile Clients
|
||||
--------------
|
||||
|
||||
@@ -115,7 +115,7 @@ the share. This updates the encryption, and then the share owner can remove the
|
||||
individual shares.
|
||||
|
||||
Recovery Key Password
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If your Nextcloud administrator has enabled the recovery key feature, you can
|
||||
choose to use this feature for your account. If you enable "Password recovery"
|
||||
@@ -142,7 +142,7 @@ There may be other files that are not encrypted; only files that are exposed to
|
||||
third-party storage providers are guaranteed to be encrypted.
|
||||
|
||||
Change Private Key Password
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This option is only available if your log-in password, but not your encryption
|
||||
password, was changed by your administrator. This can occur if your Nextcloud
|
||||
|
||||
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
@@ -105,5 +105,5 @@ to create new address books, simply by specifying an address books name.
|
||||
|
||||
The Contacts settings also enables you to share, export and delete address
|
||||
books. You will also find the CardDAV URLs there.
|
||||
See :doc:`../pim/` for more details about syncing your adress books
|
||||
See :doc:`index` for more details about syncing your adress books
|
||||
with iOS, macOS, Thunderbird and other CardDAV clients.
|
||||
|
||||
@@ -32,22 +32,22 @@ Häufig gestellte Fragen zur Verschlüsselung
|
||||
Wie kann die Verschlüsselung deaktiviert werden?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Um die Verschlüsselung zu deaktivieren müssen Sie das :ref:`"alles entschlüsseln"
|
||||
<encryption_label>`-Skript ausführen, welches alle Daten wieder entschlüsselt und
|
||||
Um die Verschlüsselung zu deaktivieren müssen Sie das `"alles entschlüsseln"
|
||||
<../../admin_manual/configuration_server/occ_command.html#encryption-label>`_-Skript ausführen, welches alle Daten wieder entschlüsselt und
|
||||
die Verschlüsselung anschließend deaktiviert.
|
||||
|
||||
Kann die Verschlüsselung mithilfe des Wiederherstellungs-Schlüssels deaktiviert werden?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Ja, *falls* jeder Nutzer den :ref:`Datei-Wiederherstellungs-Schlüssel
|
||||
<enable-file-recovery-key>` verwendet, können unter Verwendung des :ref:`"alles entschlüsseln"
|
||||
<encryption_label>`-Skripts alle Daten wieder entschlüsselt werden.
|
||||
Ja, *falls* jeder Nutzer den `Datei-Wiederherstellungs-Schlüssel
|
||||
<../../admin_manual/configuration_files/encryption_configuration.html#enabling-users-file-recovery-keys>`_ verwendet, können unter Verwendung des `"alles entschlüsseln"
|
||||
<../../admin_manual/configuration_server/occ_command.html#encryption-label>`_-Skripts alle Daten wieder entschlüsselt werden.
|
||||
|
||||
Kann die Verschlüsselung ohne das Passwort eines Nutzers deaktiviert werden?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sollte das Passwort eines Nutzers oder sein :ref:`Datei-Wiederherstellungs-Schlüssel
|
||||
<enable-file-recovery-key>` unbekannt sein, können die Daten dieses Nutzers nicht
|
||||
Sollte das Passwort eines Nutzers oder sein `Datei-Wiederherstellungs-Schlüssel
|
||||
<../../admin_manual/configuration_files/encryption_configuration.html#enabling-users-file-recovery-keys>`_ unbekannt sein, können die Daten dieses Nutzers nicht
|
||||
wieder entschlüsselt werden.
|
||||
Eine Entschlüsselung unmittelbar nach dem Login wäre gefährlich, da die Entschlüsselung
|
||||
sehr wahrscheinlich aufgrund einer Zeitüberschreitung abgebrochen werden würde.
|
||||
@@ -101,7 +101,7 @@ Zugriff auf diese Daten mehr hat. Dies aktualisiert die Verschlüsselung, wonach
|
||||
Teilen mit diesem Nutzer wieder deaktiviert werden kann.
|
||||
|
||||
Wiederherstellungs-Schlüssel
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Wenn Ihr Nextcloud-Administrator die Wiederstellungs-Schlüssel-Funktion aktiviert hat,
|
||||
können Sie die Funktion für Ihren Account aktivieren. Wenn Sie "Password-Wiederherstellung"
|
||||
@@ -128,7 +128,7 @@ Es kann weitere Daten geben, die nicht verschlüsselt werden; Daten, die bei ext
|
||||
Speicheranbietern gesichert werden, sind auf jeden Fall verschlüsselt.
|
||||
|
||||
Ändern des Passworts
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Diese Option ist verfügbar, sollte Ihr Administrator Ihr Login-Passwort (aber nicht das
|
||||
Passwort zum Verschlüsseln Ihrer Daten) geändert haben. Dies kann z.B. dann der Fall sein,
|
||||
|
||||
@@ -12,6 +12,5 @@ können diese Apps aber mit einem Klick auf "Aktivieren" unter Apps -> Produktiv
|
||||
calendar
|
||||
sync_ios
|
||||
sync_osx
|
||||
sync_kde
|
||||
sync_thunderbird
|
||||
troubleshooting
|
||||
|
||||
Reference in New Issue
Block a user