Add start for german user manual

Signed-off-by: Lukas Reschke <lukas@statuscode.ch>
This commit is contained in:
Lukas Reschke
2017-02-16 14:40:16 +01:00
parent 5252c3bee9
commit 675b1d5e72
186 changed files with 2644 additions and 0 deletions

Binary file not shown.

Binary file not shown.

168
user_manual_de/Makefile Normal file
View File

@@ -0,0 +1,168 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " pdf to make PDF files"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html: html-com
html-all: html-release html-com
html-release:
$(SPHINXBUILD) -b html -D html_theme='nextcloud_release' $(ALLSPHINXOPTS) $(BUILDDIR)/html/release
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/release."
html-com:
$(SPHINXBUILD) -b html -D html_theme='nextcloud_com' $(ALLSPHINXOPTS) $(BUILDDIR)/html/com
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/com."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OwncloudDocumentation.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OwncloudDocumentation.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/OwncloudDocumentation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OwncloudDocumentation"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
pdf:
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
@echo
@echo "build finished. the text files are in $(BUILDDIR)/pdf."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "build finished. the text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

296
user_manual_de/conf.py Normal file
View File

@@ -0,0 +1,296 @@
# -*- coding: utf-8 -*-
#
# ownCloud Documentation documentation build configuration file, created by
# sphinx-quickstart on Mon Oct 22 23:16:40 2012-2014.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.todo', 'rst2pdf.pdfbuilder']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['../_shared_assets/templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'contents'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '11'
# The full version, including alpha/beta/rc tags.
release = '11'
# General information about the project.
project = u'Nextcloud %s Benutzerhandbuch' % (version)
copyright = u'2012-2016, Die Nextcloud Entwickler'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['../_shared_assets/themes']
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nextcloud_com'
html_theme_options = {
# "rightsidebar": "true",
}
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = "Benutzerhandbuch"
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../_shared_assets/static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'NextcloudBenutzerHandbuch'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('contents', 'Nextcloud_User_Manual.tex', u'Nextcloud Benutzerhandbuch',
u'Die Nextcloud Entwickler', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = '../_shared_assets/static/logo-blue.pdf'
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for pdf page output -----------------------------------------------
pdf_documents = [('contents', u'NextcloudBenutzerhandbuch', u'Nextcloud Benutzerhandbuch', u'Die Nextcloud Entwickler'),]
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('contents', 'nextcloudbenutzerhandbuch', u'Nextcloud Benutzerhandbuch',
[u'Die Nextcloud Entwickler'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('contents', 'NextcloudBenutzerhandbuch', u'Nextcloud Benutzerhandbuch',
u'Die Nextcloud Entwickler', 'Nextcloud', 'Das Nextcloud Benutzerhandbuch.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'Nextcloud Benutzerhandbuch'
epub_author = u'Die Nextcloud Entwickler'
epub_publisher = u'Die Nextcloud Entwickler'
epub_copyright = u'2012-2016, Die Nextcloud Entwickler'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
#epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Include todos?
todo_include_todos = True
# substitutions go here
rst_epilog = '.. |version| replace:: %s' % version

View File

@@ -0,0 +1,19 @@
.. _contents:
=================
Table of Contents
=================
.. toctree::
:maxdepth: 2
index
whats_new
webinterface
files/index
pim/index
userpreferences
user_2fa
session_management
external_storage/index

View File

@@ -0,0 +1,13 @@
============================
Configuring External Storage
============================
The External Storage application allows you to mount external storage services,
such as Google Drive, Dropbox, Amazon S3, SMB/CIFS fileservers, and FTP servers
in Nextcloud. Your Nextcloud server administrator controls which of these are
available to you. Please see `Configuring External Storage (GUI)
<https://docs.nextcloud.org/server/11/admin_manual/configuration_files/
external_storage_configuration_gui.html>`_ in the Nextcloud Administrator's
manual for configuration howtos and examples.
.. TODO ON RELEASE: Update version number above on release

View File

@@ -0,0 +1,9 @@
================
External Storage
================
.. toctree::
:maxdepth: 1
external_storage

View File

@@ -0,0 +1,508 @@
======================================
Accessing Nextcloud Files Using WebDAV
======================================
Nextcloud fully supports the WebDAV protocol, and you can connect and synchronize
with your Nextcloud files over WebDAV. In this chapter you will learn how to
connect Linux, Mac OS X, Windows, and mobile devices to your Nextcloud server via
WebDAV. Before we get into configuring WebDAV, let's take a quick look at the
recommended way of connecting client devices to your Nextcloud servers.
Nextcloud Desktop and Mobile Clients
------------------------------------
The recommended method for keeping your desktop PC synchronized with your
Nextcloud server is by using the `Nextcloud/ownCloud sync clients
<https://nextcloud.com/install/#install-clients>`_. You can configure the client
to save files in any local directory you want, and you choose which directories
on the Nextcloud server to sync with. The client displays the current connection
status and logs all activity, so you always know which remote files have been
downloaded to your PC, and you can verify that files created and updated on your
local PC are properly synchronized with the server.
The recommended method for syncing your Nextcloud server with Android and
Apple iOS devices is by using the `mobile apps
<https://nextcloud.com/install/>`_.
To connect to your Nextcloud server with the mobile apps, use the
base URL and folder only::
example.com/nextcloud
In addition to the mobile apps provided by Nextcloud or Nextcloud, you can use other apps to
connect to Nextcloud from your mobile device using WebDAV. `WebDAV Navigator`_ is
a good (proprietary) app for `Android devices`_ and `iPhones`_. The URL to use on these is::
example.com/nextcloud/remote.php/dav/files/USERNAME/
WebDAV Configuration
--------------------
If you prefer, you may also connect your desktop PC to your Nextcloud server by
using the WebDAV protocol rather than using a special client application. Web
Distributed Authoring and Versioning (WebDAV) is a Hypertext Transfer Protocol
(HTTP) extension that makes it easy to create, read, and edit files on Web
servers. With WebDAV you can access your Nextcloud shares on Linux, Mac OS X and
Windows in the same way as any remote network share, and stay synchronized.
.. note:: In the following examples, You must adjust **example.com/** to the
URL of your Nextcloud server installation.
Accessing Files Using Linux
---------------------------
You can access files in Linux operating systems using the following methods.
Nautilus File Manager
^^^^^^^^^^^^^^^^^^^^^
Use the ``davs://`` protocol to connect the Nautilus file manager to your
Nextcloud share::
davs://example.com/nextcloud/remote.php/dav/files/USERNAME/
.. note:: If your server connection is not HTTPS-secured, use `dav://` instead
of `davs://`.
.. image:: ../images/webdav_gnome3_nautilus.png
:alt: screenshot of configuring Nautilus file manager to use WebDAV
Accessing Files with KDE and Dolphin File Manager
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To access your Nextcloud files using the Dolphin file manager in KDE, use
the ``webdav://`` protocol::
webdav://example.com/nextcloud/remote.php/dav/files/USERNAME/
.. image:: ../images/webdav_dolphin.png
:alt: screenshot of configuring Dolphin file manager to use WebDAV
You can create a permanent link to your Nextcloud server:
#. Open Dolphin and click "Network" in the left hand "Places" column.
#. Click on the icon labeled **Add a Network Folder**.
The resulting dialog should appear with WebDAV already selected.
#. If WebDAV is not selected, select it.
#. Click **Next**.
#. Enter the following settings:
* Name: The name you want to see in the **Places** bookmark, for example Nextcloud.
* User: The Nextcloud username you used to log in, for example admin.
* Server: The Nextcloud domain name, for example **example.com** (without
**http://** before or directories afterwards).
* Folder -- Enter the path ``nextcloud/remote.php/dav/files/USERNAME/``.
#. (Optional) Check the "Create icon checkbox" for a bookmark to appear in the
Places column.
#. (Optional) Provide any special settings or an SSL certificate in the "Port &
Encrypted" checkbox.
Creating WebDAV Mounts on the Linux Command Line
------------------------------------------------
You can create WebDAV mounts from the Linux command line. This is useful if you
prefer to access Nextcloud the same way as any other remote filesystem mount.
The following example shows how to create a personal mount and have it mounted
automatically every time you log in to your Linux computer.
1. Install the ``davfs2`` WebDAV filesystem driver, which allows you to mount
WebDAV shares just like any other remote filesystem. Use this command to
install it on Debian/Ubuntu::
apt-get install davfs2
2. Use this command to install it on CentOS, Fedora, and openSUSE::
yum install davfs2
3. Add yourself to the ``davfs2`` group::
usermod -aG davfs2 <username>
3. Then create an ``nextcloud`` directory in your home directory for the
mountpoint, and ``.davfs2/`` for your personal configuration file::
mkdir ~/nextcloud
mkdir ~/.davfs2
4. Copy ``/etc/davfs2/secrets`` to ``~/.davfs2``::
cp /etc/davfs2/secrets ~/.davfs2/secrets
5. Set yourself as the owner and make the permissions read-write owner only::
chown <username>:<username> ~/.davfs2/secrets
chmod 600 ~/.davfs2/secrets
6. Add your Nextcloud login credentials to the end of the ``secrets`` file,
using your Nextcloud server URL and your Nextcloud username and password::
example.com/nextcloud/remote.php/dav/files/USERNAME/ <username> <password>
7. Add the mount information to ``/etc/fstab``::
example.com/nextcloud/remote.php/dav/files/USERNAME/ /home/<username>/nextcloud
davfs user,rw,auto 0 0
8. Then test that it mounts and authenticates by running the following
command. If you set it up correctly you won't need root permissions::
mount ~/nextcloud
9. You should also be able to unmount it::
umount ~/nextcloud
Now every time you login to your Linux system your Nextcloud share should
automatically mount via WebDAV in your ``~/nextcloud`` directory. If you prefer
to mount it manually, change ``auto`` to ``noauto`` in ``/etc/fstab``.
Known Issues
------------
Problem
^^^^^^^
Resource temporarily unavailable
Solution
^^^^^^^^
If you experience trouble when you create a file in the directory,
edit ``/etc/davfs2/davfs2.conf`` and add::
use_locks 0
Problem
^^^^^^^
Certificate warnings
Solution
^^^^^^^^
If you use a self-signed certificate, you will get a warning. To
change this, you need to configure ``davfs2`` to recognize your certificate.
Copy ``mycertificate.pem`` to ``/etc/davfs2/certs/``. Then edit
``/etc/davfs2/davfs2.conf`` and uncomment the line ``servercert``. Now add the
path of your certificate as in this example::
servercert /etc/davfs2/certs/mycertificate.pem
Accessing Files Using Mac OS X
------------------------------
.. note:: The Mac OS X Finder suffers from a `series of implementation problems
<http://sabre.io/dav/clients/finder/>`_ and should only be used if the
Nextcloud server runs on **Apache** and **mod_php**, or **Nginx 1.3.8+**.
To access files through the Mac OS X Finder:
1. Choose **Go > Connect to Server**.
The "Connect to Server" window opens.
2. Specify the address of the server in the **Server Address** field.
.. image:: ../images/osx_webdav1.png
:alt: Screenshot of entering your Nextcloud server address on Mac OS X
For example, the URL used to connect to the Nextcloud server
from the Mac OS X Finder is::
https://example.com/nextcloud/remote.php/dav/files/USERNAME/
.. image:: ../images/osx_webdav2.png
3. Click **Connect**.
The device connects to the server.
For added details about how to connect to an external server using Mac OS X,
check the `vendor documentation
<http://docs.info.apple.com/article.html?path=Mac/10.6/en/8160.html>`_
Accessing Files Using Microsoft Windows
---------------------------------------
It is best to use a suitable WebDAV client from the
`WebDAV Project page <http://www.webdav.org/projects/>`_ .
If you must use the native Windows implementation, you can map Nextcloud to a new
drive. Mapping to a drive enables you to browse files stored on an Nextcloud
server the way you would files stored in a mapped network drive.
Using this feature requires network connectivity. If you want to store your
files offline, use the Desktop Client to sync all files on your
Nextcloud to one or more directories of your local hard drive.
.. note:: Prior to mapping your drive, you must permit the use of Basic
Authentication in the Windows Registry. The procedure is documented in
KB841215_ and differs between Windows XP/Server 2003 and Windows Vista/7.
Please follow the Knowledge Base article before proceeding, and follow the
Vista instructions if you run Windows 7.
.. _KB841215: http://support.microsoft.com/kb/841215
Mapping Drives With the Command Line
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following example shows how to map a drive using the command line. To map
the drive:
1. Open a command prompt in Windows.
2. Enter the following line in the command prompt to map to the computer Z
drive::
net use Z: https://<drive_path>/remote.php/dav/files/USERNAME/ /user:youruser
yourpassword
where <drive_path> is the URL to your Nextcloud server.
For example: ``net use Z: https://example.com/nextcloud/remote.php/dav/files/USERNAME/
/user:youruser yourpassword``
The computer maps the files of your Nextcloud account to the drive letter Z.
.. note:: Though not recommended, you can also mount the Nextcloud server
using HTTP, leaving the connection unencrypted. If you plan to use HTTP
connections on devices while in a public place, we strongly recommend using a
VPN tunnel to provide the necessary security.
An alternative command syntax is::
net use Z: \\example.com@ssl\nextcloud\remote.php\dav /user:youruser
yourpassword
Mapping Drives With Windows Explorer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To map a drive using the Microsoft Windows Explorer:
1. Migrate to your computer in Windows Explorer.
2. Right-click on **Computer** entry and select **Map network drive...** from
the drop-down menu.
3. Choose a local network drive to which you want to map Nextcloud.
4. Specify the address to your Nextcloud instance, followed by
**/remote.php/dav/files/USERNAME/**.
For example::
https://example.com/nextcloud/remote.php/dav/files/USERNAME/
.. note:: For SSL protected servers, check **Reconnect at logon** to ensure
that the mapping is persistent upon subsequent reboots. If you want to
connect to the Nextcloud server as a different user, check **Connect using
different credentials**.
.. figure:: ../images/explorer_webdav.png
:scale: 80%
:alt: screenshot of mapping WebDAV on Windows Explorer
5. Click the ``Finish`` button.
Windows Explorer maps the network drive, making your Nextcloud instance
available.
Accessing Files Using Cyberduck
-------------------------------
`Cyberduck <https://cyberduck.io/?l=en>`_ is an open source FTP and SFTP,
WebDAV, OpenStack Swift, and Amazon S3 browser designed for file transfers on
Mac OS X and Windows.
.. note:: This example uses Cyberduck version 4.2.1.
To use Cyberduck:
1. Specify a server without any leading protocol information. For example:
``example.com``
2. Specify the appropriate port. The port you choose depends on whether or not
your Nextcloud server supports SSL. Cyberduck requires that you select a
different connection type if you plan to use SSL. For example:
80 (for WebDAV)
443 (for WebDAV (HTTPS/SSL))
3. Use the 'More Options' drop-down menu to add the rest of your WebDAV URL into
the 'Path' field. For example:
``remote.php/dav/files/USERNAME/``
Now Cyberduck enables file access to the Nextcloud server.
Accessing public shares over WebDAV
-----------------------------------
Nextcloud provides the possibility to access public shares over WebDAV.
To access the public share, open::
https://example.com/nextcloud/public.php/dav
in a WebDAV client, use the share token as username and the (optional) share password
as password.
Known Problems
--------------
Problem
^^^^^^^
Windows does not connect using HTTPS.
Solution 1
^^^^^^^^^^
The Windows WebDAV Client might not support Server Name Indication (SNI) on
encrypted connections. If you encounter an error mounting an SSL-encrypted
Nextcloud instance, contact your provider about assigning a dedicated IP address
for your SSL-based server.
Solution 2
^^^^^^^^^^
The Windows WebDAV Client might not support TSLv1.1 / TSLv1.2 connections. If
you have restricted your server config to only provide TLSv1.1 and above the
connection to your server might fail. Please refer to the WinHTTP_ documentation
for further information.
.. _WinHTTP: https://msdn.microsoft.com/en-us/library/windows/desktop/aa382925.aspx#WinHTTP_5.1_Features
Problem
^^^^^^^
You receive the following error message: **Error 0x800700DF: The file size
exceeds the limit allowed and cannot be saved.**
Solution
^^^^^^^^
Windows limits the maximum size a file transferred from or to a WebDAV share
may have. You can increase the value **FileSizeLimitInBytes** in
**HKEY_LOCAL_MacHINE\\SYSTEM\\CurrentControlSet\\Services\\WebClient\\Parameters
** by clicking on **Modify**.
To increase the limit to the maximum value of 4GB, select **Decimal**, enter a
value of **4294967295**, and reboot Windows or restart the **WebClient**
service.
Problem
^^^^^^^
Accessing your files from Microsoft Office via WebDAV fails.
Solution
^^^^^^^^
Known problems and their solutions are documented in the KB2123563_ article.
Problem
^^^^^^^
Cannot map Nextcloud as a WebDAV drive in Windows using self-signed certificate.
Solution
^^^^^^^^
#. Go to the your Nextcloud instance via your favorite Web browser.
#. Click through until you get to the certificate error in the browser status
line.
#. View the cert, then from the Details tab, select Copy to File.
#. Save to the desktop with an arbitrary name, for example ``myNextcloud.cer``.
#. Start, Run, MMC.
#. File, Add/Remove Snap-In.
#. Select Certificates, Click Add, My User Account, then Finish, then OK.
#. Dig down to Trust Root Certification Authorities, Certificates.
#. Right-Click Certificate, Select All Tasks, Import.
#. Select the Save Cert from the Desktop.
#. Select Place all Certificates in the following Store, Click Browse,
#. Check the Box that says Show Physical Stores, Expand out Trusted Root
Certification Authorities, and select Local Computer there, click OK,
Complete the Import.
#. Check the list to make sure it shows up. You will probably need to Refresh
before you see it. Exit MMC.
#. Open Browser, select Tools, Delete Browsing History.
#. Select all but In Private Filtering Data, complete.
#. Go to Internet Options, Content Tab, Clear SSL State.
#. Close browser, then re-open and test.
Problem
^^^^^^^
You cannot download more than 50 MB or upload large Files when the upload takes
longer than 30 minutes using Web Client in Windows 7.
Solution
^^^^^^^^
Workarounds are documented in the KB2668751_ article.
Accessing Files Using cURL
--------------------------
Since WebDAV is an extension of HTTP cURL can be used to script file operations.
To create a folder with the current date as name:
.. code-block:: bash
$ curl -u user:pass -X MKCOL "https://example.com/nextcloud/remote.php/dav/files/USERNAME/$(date '+%d-%b-%Y')"
To upload a file ``error.log`` into that directory:
.. code-block:: bash
$ curl -u user:pass -T error.log "https://example.com/nextcloud/remote.php/dav/files/USERNAME/$(date '+%d-%b-%Y')/error.log"
To move a file:
.. code-block:: bash
$ curl -u user:pass -X MOVE --header 'Destination: https://example.com/nextcloud/remote.php/dav/files/USERNAME/target.jpg' https://example.com/nextcloud/remote.php/dav/files/USERNAME/source.jpg
To get the properties of files in the root folder:
.. code-block:: bash
$ curl -X PROPFIND -H "Depth: 1" -u user:pass https://example.com/nextcloud/remote.php/dav/files/USERNAME/ | xml_pp
<?xml version="1.0" encoding="utf-8"?>
<d:multistatus xmlns:d="DAV:" xmlns:oc="http://nextcloud.org/ns" xmlns:s="http://sabredav.org/ns">
<d:response>
<d:href>/nextcloud/remote.php/dav/files/USERNAME/</d:href>
<d:propstat>
<d:prop>
<d:getlastmodified>Tue, 13 Oct 2015 17:07:45 GMT</d:getlastmodified>
<d:resourcetype>
<d:collection/>
</d:resourcetype>
<d:quota-used-bytes>163</d:quota-used-bytes>
<d:quota-available-bytes>11802275840</d:quota-available-bytes>
<d:getetag>"561d3a6139d05"</d:getetag>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
<d:response>
<d:href>/nextcloud/remote.php/dav/files/USERNAME/welcome.txt</d:href>
<d:propstat>
<d:prop>
<d:getlastmodified>Tue, 13 Oct 2015 17:07:35 GMT</d:getlastmodified>
<d:getcontentlength>163</d:getcontentlength>
<d:resourcetype/>
<d:getetag>"47465fae667b2d0fee154f5e17d1f0f1"</d:getetag>
<d:getcontenttype>text/plain</d:getcontenttype>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
</d:multistatus>
.. _KB2668751: https://support.microsoft.com/kb/2668751
.. _KB2123563: https://support.microsoft.com/kb/2123563
.. _WebDAV Navigator: http://seanashton.net/webdav/
.. _Android devices: https://play.google.com/store/apps/details?id=com.schimera.webdavnavlite
.. _iPhones: https://itunes.apple.com/app/webdav-navigator/id382551345
.. _BlackBerry devices: http://appworld.blackberry.com/webstore/content/46816

View File

@@ -0,0 +1,217 @@
======================================================
Accessing your Files Using the Nextcloud Web Interface
======================================================
You can access your Nextcloud files with the Nextcloud Web interface and create,
preview, edit, delete, share, and re-share files. Your Nextcloud administrator
has the option to disable these features, so if any of them are missing on your
system ask your server administrator.
.. figure:: ../images/files_page.png
:alt: The Files view screen.
Tagging Files
-------------
You can assign tags to files. To create tags, open a file to the Details view.
Then type your tags. To enter more than one tag press the return key after
creating each tag. All tags are system tags, and are shared by all users on your
Nextcloud server.
.. figure:: ../images/files_page-7.png
:alt: Creating file tags.
Then use the Tags filter on the left sidebar to filter files by tags.
.. figure:: ../images/files_page-8.png
:alt: Viewing file tags.
Comments
--------
Use the Details view to add and read comments on any file or folder. Comments
are visible to everyone who has access to the file.
.. figure:: ../images/file_menu_comments_2.png
:alt: Creating and viewing comments.
Video Player
------------
You can play videos in Nextcloud with the Video Player app by simply clicking on
the file. Video streaming by the native Nextcloud video player depends on your Web browser
and the video format. If your Nextcloud administrator has enabled video
streaming, and it doesn't work in your Web browser, it may be a browser issue. See https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats#Browser_compatibility for supported multimedia formats in Web browsers.
.. figure:: ../images/video_player_2.png
:alt: Watching a movie.
File Controls
-------------
Nextcloud can display thumbnail previews for image files, MP3 covers,
and text files, if this enabled by your server administrator. Hover your cursor
over a file or folder to expose the controls for the following operations:
Favorites
Click the star to the left of the file icon to mark it as a favorite, and
quickly find all of your favorites with the Favorites filter on the left
sidebar.
.. figure:: ../images/files_page-1.png
:alt: Marking Favorite files.
Share
Share the file or folder with a group or other users, and create public
shares with hyperlinks. You can also see who you have shared with already,
and revoke shares by clicking the trash can icon.
.. note:: New in 9.0, you can see all re-shares of your original file shares.
If username auto-completion
is enabled, when you start typing the user or group name Nextcloud will
automatically complete it for you. If your administrator has enabled email
notifications, you can send an email notification of the new share from the
sharing screen.
.. figure:: ../images/files_page-2.png
:alt: Sharing files.
You have five share permissions:
* Can share; allows the users you share with to re-share.
* Can edit; allows the users you share with to edit your shared files, and to collaborate using the Documents app.
* Create; allows the users you share with to create new files and add them to the share.
* Change; allows uploading a new version of a shared file and replacing it.
* Delete; allows the users you share with to delete shared files.
Overflow Menu
The Overflow menu (three dots) displays file details, and allows you to
rename, download, or delete files.
.. figure:: ../images/files_page-3.png
:alt: Overflow menu.
The Details view shows Activities, Sharing, and Versions information.
.. figure:: ../images/files_page-4.png
:alt: Details screen.
The **Settings** gear icon at the lower left allows you to show or hide hidden
files in your Nextcloud Web interface. These are also called dotfiles, because
they are prefixed with a dot, e.g. ``.mailfile``. The dot tells your operating
system to hide these files in your file browsers, unless you choose to display
them. Usually these are configuration files, so having the option to hide them
reduces clutter.
.. figure:: ../images/hidden_files.png
:alt: Hiding or displaying hidden files.
Previewing Files
----------------
You can display uncompressed text files, OpenDocument files, videos, and image
files in the Nextcloud embedded viewers by clicking on the file name. There may
be other file types you can preview if your Nextcloud administrator has enabled
them. If Nextcloud cannot display a file, it starts a download process and
downloads the file to your computer.
Navigating Inside Your Nextcloud
--------------------------------
Navigating through folders in Nextcloud is as simple as clicking on a folder to
open it and using the back button on your browser to move to a previous level.
Nextcloud also provides a navigation bar at the top of the Files field for quick
navigation.
Sharing Status Icons
--------------------
Any folder that has been shared is marked with the ``Shared`` overlay icon.
Public link shares are marked with a chain link. Un-shared folders are blank.
.. figure:: ../images/files_page-5.png
:alt: Share status icons.
Creating or Uploading Files and Directories
-------------------------------------------
Upload or create new files or folders directly in an Nextcloud folder by clicking
on the *New* button in the Files app.
.. figure:: ../images/files_page-6.png
:alt: The New file/folder/upload menu.
The *New* button provides the following options:
Up arrow
Upload files from your computer into Nextcloud. You can also upload files by
dragging and dropping them from your file manager.
Text file
Creates a new text file and adds the file to your current folder.
Folder
Creates a new folder in the current folder.
Selecting Files or Folders
--------------------------
You can select one or more files or folders by clicking on their checkboxes. To
select all files in the current directory, click on the checkbox located at the
top of the files listing.
When you select multiple files, you can delete all of them, or download them as
a ZIP file by using the ``Delete`` or ``Download`` buttons that appear at the
top.
.. note:: If the ``Download`` button is not visible, the administrator has
disabled this feature.
Filtering the Files View
------------------------
The right sidebar on the Files page contains several filters for quickly sorting
and managing your files.
All files
The default view; displays all files that you have access to.
Favorites
Files or folders marked with the yellow star.
Shared with you
Displays all files shared with you by another user or group.
Shared with others
Displays all files that you have shared with other users or groups.
Shared by link
Displays all files that are shared by you via public link.
External Storage
Files that you have access to on external storage devices and services such
as Dropbox, Google, and Amazon S3.
Moving Files
------------
You can move files and folders by dragging and dropping them into any directory.
Change in Share Expiration Date
-------------------------------
In older versions of Nextcloud, you could set an expiration date on both local
and public shares. Now you can set an expiration date only on public shares,
and local shares do not expire when public shares expire. The only way to
"expire" a local share is to click the trash can icon to un-share your files.
Creating or Connecting to a Federation Share Link
-------------------------------------------------
Federated Cloud Sharing allows you to mount file shares from remote Nextcloud
servers, and manage them just like a local share. In Nextcloud 9 the process for
creating a new sharing link is easier and more streamlined. See
:doc:`federated_cloud_sharing` to learn to how to create and connect to new
Federated Cloud shares.

View File

@@ -0,0 +1,57 @@
======================
Managing Deleted Files
======================
When you delete a file in Nextcloud, it is not immediately deleted permanently.
Instead, it is moved into the trash bin. It is not permanently deleted until
you manually delete it, or when the Deleted Files app deletes it to make room
for new files.
Find your deleted files by clicking on the **Deleted files**
button on the Files page of the Nextcloud Web interface. You'll have options to
either restore or permanently delete files.
Quotas
------
Deleted files are not counted against your storage quota. Only files that
originate with users count against their quotas, not files
shared with them that originate from other users. (See :doc:`quota` to learn
more about quotas.)
What Happens When Shared Files Are Deleted
------------------------------------------
Deleting files gets a little complicated when they are shared files, as this
scenario illustrates:
1. User1 shares a folder "test" with User2 and User3
2. User2 (the recipient) deletes a file/folder "sub" inside of "test"
3. The folder "sub" will be moved to the trashbin of both User1 (owner) and
User2 (recipient)
4. But User3 will not have a copy of "sub" in her trash bin
When User1 deletes "sub" then it is moved to User1's trash bin. It is
deleted from User2 and User3, but not placed in their trash bins.
When you share files, other users may copy, rename, move, and share them with
other people, just as they can for any computer files; Nextcloud does not have
magic powers to prevent this.
How the Deleted Files app Manages Storage Space
-----------------------------------------------
To ensure that users do not run over their storage quotas, the Deleted Files
app allocates a maximum of 50% of their currently available free space to
deleted files. If your deleted files exceed this limit, Nextcloud deletes the
oldest files (files with the oldest timestamps from when they were deleted)
until it meets the memory usage limit again.
Nextcloud checks the age of deleted files every time new files are added to the
deleted files. By default, deleted files stay in the trash bin for 180 days. The
Nextcloud server administrator can adjust this value in the ``config.php`` file
by setting the ``trashbin_retention_obligation`` value. Files older than the
``trashbin_retention_obligation`` value will be deleted permanently.
Additionally, Nextcloud calculates the maximum available space every time a new
file is added. If the deleted files exceed the new maximum allowed space
Nextcloud will expire old deleted files until the limit is met once again.

View File

@@ -0,0 +1,32 @@
==================================
Desktop and Mobile Synchronization
==================================
For synchronizing files with your desktop computer, we recommend using the
`Nextcloud Sync Client`_ for Windows, Mac OS X and Linux until the Nextcloud
Sync Client will be released..
The Nextcloud Desktop Sync Client enables you to connect to your private
Nextcloud Server.
You can create folders in your home directory, and keep the contents of those
folders synced with your Nextcloud server. Simply copy a file into the directory
and the Nextcloud desktop client does the rest. Make a change to the files on one
computer, it will flow across the others using these desktop sync clients.
You will always
have your latest files with you wherever you are.
Its usage is documented separately in the `Nextcloud Desktop Client Manual`_.
.. _Nextcloud Sync Client: https://nextcloud.com/install/
.. _Nextcloud Desktop Client Manual: https://docs.nextcloud.org/
Mobile Clients
--------------
Visit your Personal page in your Nextcloud Web interface to find download links
for Android and iOS mobile sync clients. Or, visit the `Nextcloud download page
<https://nextcloud.com/install/>`_.
Visit the `Nextcloud documentation page <https://docs.nextcloud.org/>`_ to read
the user manuals.

View File

@@ -0,0 +1,143 @@
===============================
Encrypting Your Nextcloud Files
===============================
Nextcloud includes an Encryption app, and when it is enabled by your Nextcloud
administrator all of your Nextcloud data files are automatically encrypted.
Encryption is server-wide, so when it is enabled you cannot choose to keep your
files unencrypted. You don't have to do anything special, as it uses your
Nextcloud login as the password for your unique private encryption key. Just log
in and out and manage and share your files as you normally do, and you can
still change your password whenever you want.
Its main purpose is to encrypt files on remote storage services that are
connected to your Nextcloud server, such as Dropbox and Google Drive. This is an
easy and seamless way to protect your files on remote storage. You can share
your remote files through Nextcloud in the usual way, however you cannot share
your encrypted files directly from Dropbox, Google Drive, or whatever remote
service you are using, because the encryption keys are stored on your Nextcloud
server, and are never exposed to outside service providers.
If your Nextcloud server is not connected to any remote storage services, then
it is better to use some other form of encryption such as file-level or whole
disk encryption. Because the keys are kept on your Nextcloud server, it is
possible for your Nextcloud admin to snoop in your files, and if the server is
compromised the intruder may get access to your files. (Read
`How Nextcloud uses encryption to protect your data
<https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your-data/>`_
to learn more.)
Encryption FAQ
--------------
How Can Encryption Be Disabled?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The only way to disable encryption is to run the :ref:`"decrypt all" <encryption_label>`
script, which decrypts all files and disables encryption.
Is It Possible To Disable Encryption With The Recovery Key?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Yes, *if* every user uses the :ref:`file recovery key
<enable-file-recovery-key>`, :ref:`"decrypt all" <encryption_label>` will use it
to decrypt all files.
Can Encryption Be Disabled Without The Users Password?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you don't have the users password or :ref:`file recovery key
<enable-file-recovery-key>` then there is no way to decrypt all files. What's
more, running it on login would be dangerous, because you would most likely run
into timeouts.
Is It Planned To Move This To The Next User Login Or A Background Job?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If we did that, then we would need to store your login password in the database.
This could be seen as a security issue, so nothing like that is planned.
Is Group Sharing Possible With The Recovery Key?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you mean adding users to groups and make it magically work? No. This only
works with the master key.
Using Encryption
----------------
Nextcloud encryption is pretty much set it and forget it, but you have a few
options you can use.
When your Nextcloud admin enables encryption for the first time, you must log
out and then log back in to create your encryption keys and encrypt your files.
When encryption has been enabled on your Nextcloud server you will see a yellow
banner on your Files page warning you to log out and then log back in.
.. figure:: ../images/encryption1.png
When you log back in it takes a few minutes to work, depending on how many
files you have, and then you are returned to your default Nextcloud page.
.. figure:: ../images/encryption2.png
.. note:: You must never lose your Nextcloud password, because you will lose
access to your files. Though there is an optional recovery option that your
Nextcloud administrator may enable; see the Recovery Key Password section
(below) to learn about this.
Sharing Encrypted Files
-----------------------
Only users who have private encryption keys have access to shared encrypted
files and folders. Users who have not yet created their private encryption keys
will not have access to encrypted shared files; they will see folders and
filenames, but will not be able to open or download the files. They will see a
yellow warning banner that says "Encryption App is enabled but your keys are not
initialized, please log-out and log-in again."
Share owners may need to re-share files after encryption is enabled; users
trying to access the share will see a message advising them to ask the share
owner to re-share the file with them. For individual shares, un-share and
re-share the file. For group shares, share with any individuals who can't access
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"
the administrator can read your data with a special password. This feature
enables the administrator to recover your files in the event you lose your
Nextcloud password. If the recovery key is not enabled, then there is no way to
restore your files if you lose your login password.
.. figure:: ../images/encryption3.png
Files Not Encrypted
-------------------
Only the data in your files is encrypted, and not the filenames or folder
structures. These files are never encrypted:
- Old files in the trash bin.
- Image thumbnails from the Gallery app.
- Previews from the Files app.
- The search index from the full text search app.
- Third-party app data
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
provider uses a external user back-end (for example, LDAP) and changed your
login password using that back-end configuration. In this case, you can set
your encryption password to your new login password by providing your old and
new login password. The Encryption app works only if your login password and
your encryption password are identical.

View File

@@ -0,0 +1,57 @@
=======================
Using Federation Shares
=======================
Federation Sharing allows you to mount file shares from remote Nextcloud servers, in effect
creating your own cloud of Nextclouds. You can create direct share links with
users on other Nextcloud servers.
Creating a New Federation Share
-------------------------------
Federation sharing is enabled on new or upgraded Nextcloud installations
by default. Follow these steps to create a new share with other Nextcloud or ownCloud 9+ servers:
1. Go to your ``Files`` page and click the Share icon on the file or directory
you want to share. In the sidebar enter the username and URL of the remote user
in this form: ``<username>@<oc-server-url>``. In this example, that is
``layla@remote-server/nextcloud``. The form automatically echoes the address
that you type and labels it as "remote". Click on the label.
.. figure:: ../images/direct-share-1.png
2. When your local Nextcloud server makes a successful connection with the remote
Nextcloud server you'll see a confirmation. Your only share option is **Can
edit**.
Click the Share button anytime to see who you have shared your file with. Remove
your linked share anytime by clicking the trash can icon. This only unlinks the
share, and does not delete any files.
Creating a New Federated Cloud Share via Email
----------------------------------------------
Use this method when you are sharing with users on ownCloud 8.x and older.
What if you do not know the username or URL? Then you can have Nextcloud create
the link for you and email it to your recipient.
.. figure:: ../images/create_public_share-6.png
When your recipient receives your email they will have to take a number of
steps to complete the share link. First they must open the link you sent them in
a Web browser, and then click the **Add to your Nextcloud** button.
.. figure:: ../images/create_public_share-8.png
The **Add to your Nextcloud** button changes to a form field, and your recipient
needs to enter the URL of their Nextcloud or ownCloud server in this field and press the
return key, or click the arrow.
.. figure:: ../images/create_public_share-9.png
Next, they will see a dialog asking to confirm. All they have to do is click
the **Add remote share** button and they're finished.
Remove your linked share anytime by clicking the trash can icon. This only
unlinks the share, and does not delete any files.

View File

@@ -0,0 +1,42 @@
========================
Making Anonymous Uploads
========================
You may create your own special upload directories so that other people can upload
files to you without having to log in to the server, and without being an Nextcloud
user.
They will not be allowed to see the contents of this directory, or to make any
changes. This is an excellent alternative to sending large attachments via email,
using an FTP server, or using commercial file-sharing services.
Setting Up Your Own File Drop
-----------------------------
Go to Files and create or choose the folder, the anonymous upload should be
made to.
.. image:: ../images/anonym_click_sharing.png
Check Share Link, Allow editing, Hide file listing.
.. image:: ../images/anonym_hide_file_listing.png
Now you can send the link to the uploadfolder manualy or by using the
Nextcloud send function, if your administrator has enabled it.
Uploading Files
---------------
Using the anonymous upload function is simple. You receive a link to the upload
folder, click the link, and then you'll see an Nextcloud page with a **Click to
upload** button.
.. image:: ../images/anonym_upload.png
This opens a file picker, and you select the file or directory you want to
upload. You're also able to just drop files into the window.
When your upload is completed, the filenames are listed:
.. image:: ../images/anonym_uploaded_files.png

View File

@@ -0,0 +1,244 @@
===========
Gallery App
===========
The Pictures app has been rewritten and improved, and is now called the Gallery
app. It supports more image formats, sorting, zoom, and scrolling. It also
supports advanced customizations via a simple text file.
On your main Nextcloud Files page, click the little icon at the top right,
underneath your username, to open your Gallery. The Gallery app automatically
finds all images in your Nextcloud folders, and overlays the thumbnails with the
folder names. Click on the folder thumbnails to open the folders. At the top
left you have two sorting options, alphabetical and by date.
.. figure:: ../images/gallery-1.png
:alt: Gallery folder thumbnails.
After entering any folder, click on any image to open it in slideshow mode.
This has the following features: a download button at the top center, forward
and back buttons at the right and left sides, an automatic slideshow button at
the bottom right, and a close button at the top right.
.. figure:: ../images/gallery-2.png
:alt: Gallery in slideshow mode.
Custom Configuration
--------------------
You may customize a Gallery album with a simple text file named
**gallery.cnf**, which contains parameters structured using the
`Yaml <https://en.wikipedia.org/wiki/YAML>`_ markup language. You may have
multiple **gallery.cnf** files; you need one in your own root Nextcloud folder
(your Home folder) that defines global features, and then you may have
individual per-album **gallery.cnf** files if you want to define different
behaviors in different albums.
Features
^^^^^^^^
The following general features are currently implemented:
* Native SVG support.
* Access to external shares.
The following album features are currently implemented:
* Adding a link to a file containing a description.
* Typing a simple copyright statement directly in the configuration file.
* Adding a link to a file containing a copyright statement.
* Defining a sort type and order.
* Defining the colour of the background.
* Defining if sub-albums will inherit the configuration.
The following slideshow features are currently implemented:
* Showing a button which lets you pick which background, either black or
white, to use for the picture you are currently viewing (for images with
transparent backgrounds).
Setup
^^^^^
The configuration file has to be named **gallery.cnf**. You may have multiple
per-album **gallery.cnf** files. To enable global features, place one in your
top-level folder, which is symbolised in the Web GUI by the home icon. (This
puts it in ``data/<user>/files/``.) See :ref:`an example below
<supported_variables_label>` in the **Global features** section.
.. note:: You need to refresh your browser after changing your configuration to
see your changes.
Format
^^^^^^
UTF-8, **without BOM**. A file created from within the Nextcloud Web GUI works.
Structure
^^^^^^^^^
You should include a comment in the file, so that people stumbling upon
the file know what it's for. Comments start with #.
Spacing is created using 2 spaces. **Do not use tabs.**
Take a look at the `YAML Format documentation
<http://symfony.com/doc/current/components/yaml/yaml_format.html>`_ if you are
getting error messages.
Here is an example `gallery.cnf`::
# Gallery configuration file
# Created on 31 Jan 2016 by Nextcloud User
features:
external_shares: yes
native_svg: yes
background_colour_toggle: yes
design:
background: "#ff9f00"
inherit: yes
information:
description: This is an **album description** which is only shown if there
is no `description_link`
description_link: readme.md
copyright: Copyright 2003-2016 [interfaSys sàrl](http://www.interfasys.ch),
Switzerland
copyright_link: copyright.md
inherit: yes
sorting:
type: date
order: des
inherit: yes
.. _supported_variables_label:
Supported Variables
^^^^^^^^^^^^^^^^^^^
**Global Features**
Place this in your root Nextcloud folder, which is your Home folder.
* **external_shares**: Set to **yes** in your root configuration file if you
want to load images stored on external locations, when using the
**files_external** app.
* **native_svg**: Set to **yes** in your root configuration file to enable
rendering SVG images in your browser. This may represent a security risk if
you can't fully trust your SVG files.
* **background_colour_toggle**: Set to **yes** in your root configuration file
to enable a button that toggles between black and white backgrounds on
transparent images.
.. note:: External shares are 20-50 times slower than local shares. Be prepared
to wait a long time before being able to see all the images contained in a
shared album.
**Album Configuration**
Each album can be individually configured using the following configuration
sections. Use the **inherit** parameter to pass configurations on to
sub-albums.
**Design**
* **background**: Defines the colour of the background of the photowall
using the RGB hexadecimal representation of that colour. For example:
**"#ffa033"**. You must use quotes around the value or it will
be ignored. It is strongly recommended to use a custom theme, with a CSS
loading spinner if you intend to use this feature. You can use `this colour
wheel <http://paletton.com/>`_ to find a colour you like.
* **inherit**: Set to **yes** if you want sub-folders to inherit this part of
the configuration.
**Album Presentation**
* **description**: A markdown-formatted string which will be displayed in the
info box. It can spread over multiple lines using the Yaml markers.
* **description_link**: A markdown file located within the album which will
be parsed and displayed in the info box instead of the description.
* **copyright**: A markdown-formatted string. This supports links to external
resources.
* **copyright_link**: Any file (e.g. copyright.html), in the album itself,
which will be downloaded when the user clicks on the link
* **inherit**: Set to **yes** if you want sub-folders to inherit this part of
the configuration.
See `<http://www.markitdown.net/markdown>`_ for the markdown syntax.
.. note:: Do not add links to your `copyright` string if you use the
**copyright_link** variable.
**Sorting**
* **sorting**: **date** or **name**. **date** only works for files.
* **sort_order**: **asc** or **des** (Ascending or descending).
* **inherit**: Set to **yes** if you want sub-folders to inherit this part of
the configuration.
Notes
-----
* When only the sort **type** variable has been set, the default sort order
will be used.
* When only the sort **order** variable has been found, the sort configuration
will be ignored and the script will keep looking for a valid configuration in
upper folders.
* To enable a feature such as native SVG in a public share, you need to create
in that folder a configuration file containing that feature.
* If you share a folder publicly, don't forget to add all the files you link to
(e.g. ``description.md`` or ``copyright.md``) inside the shared folder as
the user won't have access to files stored in the parent folder.
* Since people can download a whole folder as an archive, it's usually best to
include all files within a shared folder, rather than adding text directly
in the configuration file.
Examples
--------
**Sorting Only**
Applies to the current folder only::
# Gallery configuration file
sorting:
type: date
order: asc
Short description and link to copyright document, applies to the current folder
and all of its sub-folders. This also shows you the syntax you can use to
spread a description over multiple lines::
# Gallery configuration file
information:
description: | # La Maison Bleue, Winter '16
This is our Winter 2016 collection shot in **Kyoto**
Visit our [website](http://www.secretdesigner.ninja) for more information
copyright: Copyright 2015 La Maison Bleue, France
copyright_link: copyright_2015_lmb.html
inherit: yes
**Load Images From External Clouds**
.. note:: Features can only be defined in the root folder.
You can add standard configuration items to the same configuration file::
# Gallery configuration file
features:
external_shares: yes
**Enabling native SVG**
.. note:: Special features can only be defined in the root folder.
You can add standard configuration items to the same configuration file::
# Gallery configuration file
features:
native_svg: yes
Possible Future Extensions
--------------------------
Different sorting parameters for albums.

View File

@@ -0,0 +1,19 @@
=======================
Files & Synchronization
=======================
.. toctree::
:maxdepth: 1
access_webgui
access_webdav
gallery_app
deleted_file_management
desktop_mobile_sync
encrypting_files
federated_cloud_sharing
file_drop
large_file_upload
quota
version_control

View File

@@ -0,0 +1,22 @@
==================
Large File Uploads
==================
When uploading files through the web client, Nextcloud is limited by PHP and
Apache configurations. By default, PHP is configured for only 2 megabyte
uploads. As this default upload limit is not entirely useful, we recommend that
your Nextcloud admin increase the Nextcloud variables to sizes appropriate for
users.
Modifying certain Nextcloud variables requires administrative access. If you
require larger upload limits than have been provided by the default (or already
set by your administrator):
* Contact your administrator to request an increase in these variables
* Refer to the section in the `Admin Documentation
<https://docs.nextcloud.org/server/11/admin_manual/configuration_files/
big_file_upload_configuration.html>`_ that describes how to manage file
upload size limits.
.. TODO ON RELEASE: Update version number above on release

View File

@@ -0,0 +1,36 @@
=============
Storage Quota
=============
Your Nextcloud admin has the option to set a storage quota on users. Look at
the top of your Personal page to see what your quota is, and how much you have
used.
.. figure:: ../images/quota1.png
It may be helpful to understand how your quota is calculated.
Metadata (thumbnails, temporary files, cache, and encryption keys) takes up
about 10% of disk space, but is not counted against user quotas. Some apps
store information in the database, such as the Calendar and Contacts apps. This
data is excluded from your quota.
When other users share files with you, the shared files count against the
original share owner's quota. When you share a folder and allow other users or
groups to upload files to it, all uploaded and edited files count against your
quota. When you re-share files shared with you, the re-share still counts
against the quota of the original share owner.
Encrypted files are a little larger than unencrypted files; the unencrypted size
is calculated against your quota.
Deleted files that are still in the trash bin do not count against quotas. The
trash bin is set at 50% of quota. Deleted file aging is set at 30 days. When
deleted files exceed 50% of quota then the oldest files are removed until the
total is below 50%.
When version control is enabled, the older file versions are not counted against
quotas.
If you create a public share via URL, and allow uploads, any uploaded files
count against your quota.

View File

@@ -0,0 +1,33 @@
===============
Version Control
===============
Nextcloud supports simple version control system for files. Versioning creates
backups of files which are accessible via the Versions tab on the Details
sidebar. This tab contains the history of the file where you can roll back a
file to any previous version. Changes made at intervals greater than two minutes
are saved in data/[user]/versions.
.. figure:: ../images/files_versioning.png
To restore a specific version of a file, click the circular arrow to the left.
Click on the timestamp to download it.
The versioning app expires old versions automatically to make sure that
the user doesn't run out of space. This pattern is used to delete
old versions:
* For the first second we keep one version
* For the first 10 seconds Nextcloud keeps one version every 2 seconds
* For the first minute Nextcloud keeps one version every 10 seconds
* For the first hour Nextcloud keeps one version every minute
* For the first 24 hours Nextcloud keeps one version every hour
* For the first 30 days Nextcloud keeps one version every day
* After the first 30 days Nextcloud keeps one version every week
The versions are adjusted along this pattern every time a new version gets
created.
The version app never uses more that 50% of the user's currently available free
space. If the stored versions exceed this limit, Nextcloud deletes the oldest
versions until it meets the disk space limit again.

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 314 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 890 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 614 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 181 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 165 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Some files were not shown because too many files have changed in this diff Show More