Search is not available for this dataset
path string | extension string | size_bytes int64 | content_base64 string | encoding string | content string |
|---|---|---|---|---|---|
.github\workflows\fixup.yml | .yml | 995 | null | utf-8 | # This workflow is provided via the organization template repository
#
# https://github.com/nextcloud/.github
# https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization
#
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: MIT
... |
.github\workflows\generate-top-index.yml | .yml | 2,517 | null | utf-8 | name: "Build documentation index"
on:
push:
branches:
- master
tags:
- '*'
pull_request:
branches:
- master
permissions:
contents: write
jobs:
build-and-deploy:
name: Build index.html
runs-on: ubuntu-latest
steps:
- name: Cache git metadata
uses: actions/c... |
.github\workflows\generate_catalog_templates.yml | .yml | 2,339 | null | utf-8 | name: Generate catalog templates (POT) files fetched automatically by transifex
on:
workflow_dispatch:
push:
branches:
- master
paths:
- 'user_manual/**'
- '!user_manual/locale/**'
permissions:
contents: read
jobs:
user_manual:
runs-on: ubuntu-latest
steps:
- name: Chec... |
.github\workflows\labeling.yml | .yml | 2,826 | null | utf-8 | # SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: MIT
name: Labeling
on:
pull_request:
types: [opened, reopened, synchronize]
issues:
types: [opened]
permissions:
contents: read
jobs:
label-by-files:
if: github.event_name == 'pull_request'
na... |
.github\workflows\openapi.yml | .yml | 1,066 | null | utf-8 | name: OpenAPI
on: pull_request
permissions:
contents: read
concurrency:
group: openapi-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
openapi:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.... |
.github\workflows\pr-feedback.yml | .yml | 2,751 | null | utf-8 | # This workflow is provided via the organization template repository
#
# https://github.com/nextcloud/.github
# https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization
# SPDX-FileCopyrightText: 2023-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-FileCopyrightText: 2023 M... |
.github\workflows\sphinx-lint.yml | .yml | 1,321 | null | utf-8 | name: 'Sphinx Lint'
on:
pull_request:
push:
branches:
- master
- stable*
permissions:
contents: read
jobs:
sphinx-lint:
name: Lint RST files
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v... |
.github\workflows\sphinxbuild.yml | .yml | 34,976 | null | utf-8 | name: "Build documentation"
on:
pull_request:
push:
branches:
- master
- stable*
permissions:
contents: read
packages: write
concurrency:
group: build-documentation-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
# ===================================================... |
.github\workflows\transifex.yml | .yml | 1,020 | null | utf-8 | name: AutoMerge Transifex Pull Requests
on:
pull_request:
permissions:
contents: read
jobs:
approve:
if: github.event.pull_request.user.login == 'transifex-integration[bot]'
runs-on: ubuntu-latest-low
permissions:
# for hmarr/auto-approve-action to approve PRs
pull-requests: write
... |
.github\workflows\update-workflow.yml | .yml | 2,789 | null | utf-8 | name: Checkout File from Master
on:
workflow_dispatch:
inputs:
file_path:
description: 'Path to the file to checkout from master'
required: true
type: string
default: .github/workflows/sphinxbuild.yml
jobs:
checkout:
runs-on: ubuntu-latest
strategy:
fail-fa... |
admin_manual\ai\ai_as_a_service.rst | .rst | 2,651 | null | utf-8 | ===============
AI as a Service
===============
.. _ai-ai_as_a_service:
At Nextcloud, we focus on creating on-premise AI apps that run fully self-hosted on your own servers in order to preserve your privacy and data sovereignty.
However, you can also offload these resource-heavy tasks to an "AI as a Service" provider... |
admin_manual\ai\app_assistant.rst | .rst | 13,031 | null | utf-8 | ===================
Nextcloud Assistant
===================
.. _ai-app-assistant:
Nextcloud assistant is the primary graphical user interface for interacting with artificial intelligence features in Nextcloud.
It offers the graphical user interface for the unified AI Task processing API offering features like summar... |
admin_manual\ai\app_context_agent.rst | .rst | 16,787 | null | utf-8 | ==================================
App: Context Agent (context_agent)
==================================
.. _ai-app-context_agent:
The *context_agent* app is the app that provides AI agent functionality in Nextcloud's "Chat with AI" feature and acts as a backend for the :ref:`Nextcloud Assistant app<ai-app-assistant>... |
admin_manual\ai\app_context_chat.rst | .rst | 12,554 | null | utf-8 | =================
App: Context Chat
=================
.. _ai-app-context_chat:
Context Chat is an :ref:`assistant<ai-app-assistant>` feature that is implemented via an ensemble of two apps:
* the ``context_chat`` app, written purely in PHP
* the ``context_chat_backend`` ExternalApp written in Python
Together they... |
admin_manual\ai\app_live_transcription.rst | .rst | 5,733 | null | utf-8 | ==============================================================================
App: Live Transcription and Translation in Nextcloud Talk (live_transcription)
==============================================================================
.. _ai-live-transcription:
| This app provides live transcription and translation... |
admin_manual\ai\app_llm2.rst | .rst | 7,910 | null | utf-8 | ======================================
App: Local large language model (llm2)
======================================
.. _ai-app-llm2:
The *llm2* app is one of the apps that provide text processing functionality using Large language models in Nextcloud and act as a text processing backend for the :ref:`Nextcloud Assis... |
admin_manual\ai\app_recognize.rst | .rst | 6,083 | null | utf-8 | ======================================
App: Recognize
======================================
.. _ai-app-recognize:
The *recognize* app provides media tagging and face recognition functionality for the memories app. *Recognize* can group similar faces on user's photos ("face recognition"); it can add fitting tags to p... |
admin_manual\ai\app_stt_whisper2.rst | .rst | 5,027 | null | utf-8 | ================================================
App: Local Whisper Speech-To-Text (stt_whisper2)
================================================
.. _ai-app-stt_whisper2:
The *stt_whisper2* app is one of the apps that provide Speech-To-Text functionality in Nextcloud and act as a media transcription backend for the ... |
admin_manual\ai\app_summary_bot.rst | .rst | 6,403 | null | utf-8 | ==========================================
App: Summary Bot (Talk chat summarize bot)
==========================================
.. _ai-app-summary-bot:
The *Summary Bot* app utilizes Large Language Model (LLM) providers in Nextcloud and can be added to a conversation in `Nextcloud Talk` to generate summaries from th... |
admin_manual\ai\app_text2image_stablediffusion2.rst | .rst | 3,268 | null | utf-8 | =========================================================
App: Local Image Generation (text2image_stablediffusion2)
=========================================================
.. _ai-app-text2image_stablediffusion2:
The *text2image_stablediffusion2* app is one of the apps that provide image generation functionality in ... |
admin_manual\ai\app_text2speech_kokoro.rst | .rst | 3,239 | null | utf-8 | ==============================================
App: Local Text-To-Speech (text2speech_kokoro)
==============================================
.. _ai-app-text2speech_kokoro:
The *text2speech_kokoro* app is one of the apps that provide Text-To-Speech functionality in Nextcloud and act as a speech generation backend for ... |
admin_manual\ai\app_translate2.rst | .rst | 4,257 | null | utf-8 | =============================================
App: Local Machine translation 2 (translate2)
=============================================
.. _ai-app-translate2:
The *translate2* app is one of the apps that provide machine translation functionality in Nextcloud and act as a translation backend for the :ref:`Nextcloud ... |
admin_manual\ai\eu_ai_act.rst | .rst | 7,181 | null | utf-8 | ================================
Legal: Compliance with EU AI Act
================================
.. _ai-eu_ai_act:
Implementation of the transparency requirements
-----------------------------------------------
This section describes of how Nextcloud and its AI products implemented the transparency requirements.
... |
admin_manual\ai\index.rst | .rst | 441 | null | utf-8 | =======================
Artificial Intelligence
=======================
.. toctree::
:maxdepth: 2
overview
app_assistant
app_translate2
app_llm2
app_stt_whisper2
app_text2image_stablediffusion2
app_recognize
app_context_chat
app_context_agent
app_summary_bot
app_text2sp... |
admin_manual\ai\insight_and_debugging.rst | .rst | 4,162 | null | utf-8 | =====================
Insight and debugging
=====================
.. _ai-insight-and-debugging:
In order to gain insights and debug AI tasks, there are a number of occ commands
available in the `taskprocessing` namespace.
All commands listed here accept an `--output` parameter that can be set to `plain`, `json` or `... |
admin_manual\ai\overview.rst | .rst | 27,633 | null | utf-8 | ========
Overview
========
We strive to bring Artificial Intelligence features to Nextcloud. This section highlights these features, how they work and where to find them.
All of these features are completely optional. If you want to have them on your server, you need to install them via separate Nextcloud Apps.
Over... |
admin_manual\collectives\index.rst | .rst | 4,055 | null | utf-8 | ===========
Collectives
===========
Runtime Dependencies
--------------------
Collectives requires the following apps to be enabled. They're all shipped and enabled by default with
the Nextcloud server installation:
* **Teams** (with Nextcloud >= 29) or **Circles** (with Nextcloud <= 28)
* **Text**
* **Viewer**
* **... |
admin_manual\configuration_database\bigint_identifiers.rst | .rst | 1,260 | null | utf-8 | ==========================
BigInt (64bit) identifiers
==========================
Nextcloud uses big integers to store identifiers and auto-increment keys in the database.
Because changing columns on huge tables can take quite a while (up to hours or days)
depending on the number of files in the Nextcloud instance, thi... |
admin_manual\configuration_database\db_conversion.rst | .rst | 4,477 | null | utf-8 | ========================
Converting database type
========================
You can convert a SQLite database to a better performing MySQL, MariaDB or
PostgreSQL database with the Nextcloud command line tool. SQLite is good for
testing and simple single-user Nextcloud servers, but it does not scale for
multiple-user pr... |
admin_manual\configuration_database\index.rst | .rst | 242 | null | utf-8 | ======================
Database configuration
======================
.. toctree::
:maxdepth: 2
db_conversion
linux_database_configuration
mysql_4byte_support
bigint_identifiers
replication
splitting
|
admin_manual\configuration_database\linux_database_configuration.rst | .rst | 13,867 | null | utf-8 | ======================
Database configuration
======================
Nextcloud requires a database in which administrative data is stored. The following databases are currently supported:
* `MySQL <https://www.mysql.com/>`_ / `MariaDB <https://mariadb.org/>`_
* `PostgreSQL <https://www.postgresql.org/>`_
* `Oracle <h... |
admin_manual\configuration_database\mysql_4byte_support.rst | .rst | 2,508 | null | utf-8 | =============================
Enabling MySQL 4-byte support
=============================
.. note::
Be sure to backup your database before performing this database upgrade.
In order to use Emojis (textbased smilies) on your Nextcloud server with a MySQL database, the
installation needs to be tweaked a bit.
.. w... |
admin_manual\configuration_database\replication.rst | .rst | 522 | null | utf-8 | ===========
Replication
===========
.. versionadded:: 29
Nextcloud can natively split read and write operations on a database query level. Replicas are only used for reads. The default database connection will be used for writes and causal reads.
::
'dbreplica' => [
['user' => 'nextcloud', 'password... |
admin_manual\configuration_database\splitting.rst | .rst | 2,518 | null | utf-8 | ===================
Splitting databases
===================
.. warning::
This is still proof-of-concept level. Use with care.
In order to scale at some point it might make sense to split out some tables or apps
which allow it as they might be better off with a different replication methods, etc.
A first attempt... |
admin_manual\configuration_files\big_file_upload_configuration.rst | .rst | 9,453 | null | utf-8 | .. _uploading_big_files:
===========================
Uploading big files > 512MB
===========================
The default maximum file size for uploads is 512MB. You can increase this
limit up to what your filesystem and operating system allows. There are certain
hard limits that cannot be exceeded:
* < 2GB on 32Bit ... |
admin_manual\configuration_files\default_files_configuration.rst | .rst | 1,771 | null | utf-8 | =======================
Providing default files
=======================
You may distribute a set of default files and folders to all users by placing
them in directory that is readable by the webserver user. This allows you to
overwrite the files that are shipped by default with Nextcloud in
``core/skeleton``. That cu... |
admin_manual\configuration_files\encryption_configuration.rst | .rst | 17,113 | null | utf-8 | ======================
Server-side Encryption
======================
Overview
--------
Nextcloud provides several encryption methods to protect your data. These work at
different layers of the system and address different security needs. This guide
focuses on Nextcloud's built-in Server-Side Encryption (SSE).
.. not... |
admin_manual\configuration_files\encryption_details.rst | .rst | 21,633 | null | utf-8 | ==============================
Server-side encryption details
==============================
This document describes the server-side encryption scheme implemented by Nextcloud's default encryption module. This includes:
- the encryption and signature of files with a master key.
- the encryption and signature of files... |
admin_manual\configuration_files\encryption_migration.rst | .rst | 1,018 | null | utf-8 | ================================
Server-side encryption migration
================================
Encryption format
-----------------
Nextcloud still supports the legacy encryption scheme used for server side encryption where the encrypted files did not contain header information. This may still be used for installa... |
admin_manual\configuration_files\external_storage_configuration_gui.rst | .rst | 8,750 | null | utf-8 | ================
External Storage
================
The External Storage Support application enables you to mount external storage
services and devices as secondary Nextcloud storage devices. You may also allow
users to mount their own external storage services.
Enabling
--------
External Storage Support is provided ... |
admin_manual\configuration_files\federated_cloud_sharing_configuration.rst | .rst | 6,236 | null | utf-8 | ==============================
Configuring Federation Sharing
==============================
Federated Cloud Sharing is now managed by the Federation app (9.0+), and is
now called Federation sharing. When you enable the Federation app you can
easily and securely link file shares between Nextcloud servers, in effect
cr... |
admin_manual\configuration_files\files_locking_transactional.rst | .rst | 2,931 | null | utf-8 | ==========================
Transactional file locking
==========================
Nextcloud's Transactional File Locking mechanism locks files to avoid
file corruption during normal operation. It performs these functions:
* Operates at a higher level than the filesystem, so you don't need to use a
filesystem that su... |
admin_manual\configuration_files\file_conversion.rst | .rst | 372 | null | utf-8 | ===============
File conversion
===============
In the majority of cases, it is recommended that either the Pandoc or :doc:`Nextcloud Office <../office/installation>` apps
are enabled, as they provide the majority of file conversions available. Other apps may also
support their own file conversions for other file type... |
admin_manual\configuration_files\file_sharing_configuration.rst | .rst | 10,934 | null | utf-8 | .. _file-sharing-configuration:
============
File Sharing
============
Nextcloud users can share files with their Nextcloud groups and other users on
the same Nextcloud server, with Nextcloud users on :doc:`other Nextcloud servers <federated_cloud_sharing_configuration>`, and create public shares for people who are n... |
admin_manual\configuration_files\file_versioning.rst | .rst | 3,834 | null | utf-8 | ===================================
Controlling file versions and aging
===================================
The Versions app (files_versions) expires old file versions automatically to
ensure that users don't exceed their storage quotas. This is the default
pattern used to delete old versions:
* For the first second ... |
admin_manual\configuration_files\index.rst | .rst | 612 | null | utf-8 | ===========================
File sharing and management
===========================
.. toctree::
:maxdepth: 2
file_sharing_configuration
federated_cloud_sharing_configuration
big_file_upload_configuration
default_files_configuration
primary_storage
external_storage_configuration_gui
e... |
admin_manual\configuration_files\previews_configuration.rst | .rst | 4,480 | null | utf-8 | ======================
Previews configuration
======================
The Nextcloud thumbnail system generates previews of files for all
Nextcloud apps that display files, such as Files and Gallery.
The following image shows some examples of previews of various file types.
.. figure:: ../images/preview_images.png
... |
admin_manual\configuration_files\primary_storage.rst | .rst | 15,140 | null | utf-8 | =============================================
Configuring Object Storage as Primary Storage
=============================================
Nextcloud allows to configure object storages like OpenStack Swift or
Amazon Simple Storage Service (S3) or any compatible S3-implementation
(e.g. Minio or Ceph Object Gateway) as p... |
admin_manual\configuration_files\trashbin_configuration.rst | .rst | 2,479 | null | utf-8 | =========================
Deleted Items (trash bin)
=========================
If the trash bin app is enabled (default), this setting defines the policy
for when files and folders in the trash bin will be permanently deleted.
.. note::
If the user quota limit is exceeded due to deleted files in the trash bin,
... |
admin_manual\configuration_files\windows_compatible_filenames.rst | .rst | 3,037 | null | utf-8 | .. _windows_compatible_filenames:
============================
Windows compatible filenames
============================
.. note::
This feature was introduced in Nextcloud 31.
By default Nextcloud supports all filenames which are valid on the underlying server.
As Nextcloud runs only on POSIX compatible operati... |
admin_manual\configuration_mimetypes\index.rst | .rst | 2,488 | null | utf-8 | ====================
Mimetypes management
====================
Mimetype aliases
----------------
Nextcloud allows you to create aliases for mimetypes, so that you can display
custom icons for files. For example, you might want a nice audio icon for audio
files instead of the default file icon.
By default Nextcloud i... |
admin_manual\configuration_monitoring\index.rst | .rst | 951 | null | utf-8 | ==========
Monitoring
==========
OpenMetrics
-----------
.. versionadded:: 33
Nextcloud exposes a ``/metrics`` endpoint. By default, it responds only on localhost.
You can change this behaviour with ``openmetrics_allowed_clients``
::
'openmetrics_allowed_clients' => [
'192.168.0.0/16',
],
.. warning::
... |
admin_manual\configuration_server\activity_configuration.rst | .rst | 8,119 | null | utf-8 | ============
Activity app
============
The Activity app records and summarizes user-visible events across your Nextcloud instance and can
notify users via the activity stream, email, and push notifications.
It is shipped and enabled by default.
.. note::
The Activity app is designed for user notifications, not fo... |
admin_manual\configuration_server\admin_delegation_configuration.rst | .rst | 2,275 | null | utf-8 | ======================================
Administration privileges (Delegation)
======================================
Introduction
~~~~~~~~~~~~
Nextcloud has built-in functionality which permits administrators to delegate authority
to others without granting them full administration privileges (and without making
them... |
admin_manual\configuration_server\android_deep_link_handling.rst | .rst | 1,920 | null | utf-8 | ==========================
Android Deep Link Handling
==========================
Deep linking in Android allows your application to be launched directly from a URL,
making it easier for users to navigate to specific content within your app.
Starting from Android 12, handling deep links requires additional configuratio... |
admin_manual\configuration_server\antivirus_configuration.rst | .rst | 9,560 | null | utf-8 | =================
Antivirus scanner
=================
You can configure your Nextcloud server to automatically run a virus scan on
newly-uploaded files with the Antivirus app for Files. The Antivirus app for
Files integrates the open source anti-virus engine `ClamAV
<https://www.clamav.net/index.html>`_ with Nextclou... |
admin_manual\configuration_server\background_jobs_configuration.rst | .rst | 7,169 | null | utf-8 | ===============
Background jobs
===============
A system like Nextcloud sometimes requires tasks to be done on a regular basis
without the need for user interaction or hindering Nextcloud performance. For
that purpose, as a system administrator, you can define background jobs (for
example, database clean-ups) which are... |
admin_manual\configuration_server\bruteforce_configuration.rst | .rst | 10,099 | null | utf-8 | ======================
Brute force protection
======================
Introduction
------------
Nextcloud has built-in protection against brute force attempts.
The brute force protection feature is meant to protect Nextcloud servers from attempts to guess
passwords and tokens in various ways. Besides the obvious "let... |
admin_manual\configuration_server\caching_configuration.rst | .rst | 16,317 | null | utf-8 | ==============
Memory caching
==============
You can significantly improve your Nextcloud server performance with memory
caching, where frequently-requested objects are stored in memory for faster
retrieval. There are two types of caches to use: a PHP opcode cache, which is
commonly called *opcache*, and data cache fo... |
admin_manual\configuration_server\config_sample_php_parameters.rst | .rst | 119,344 | null | utf-8 | ========================
Configuration Parameters
========================
Introduction
------------
Nextcloud uses ``config/config.php`` as its main configuration file. This file controls
various fundamental aspects of server operations. It is typically modified as part of initial
deployment, when troubleshooting, a... |
admin_manual\configuration_server\dashboard_configuration.rst | .rst | 1,601 | null | utf-8 | =============
Dashboard app
=============
The Nextcloud Dashboard is your starting point of the day, giving users an overview of your upcoming appointments, urgent emails, chat messages, incoming tickets, latest tweets and much more! Users can add the widgets they like and change the background to their liking.
Enabl... |
admin_manual\configuration_server\domain_change.rst | .rst | 402 | null | utf-8 | =====================
Domain Change
=====================
Changing the domain after the first setup is currently not supported by Nextcloud. That is mainly because Nextcloud's apps don't support changing the domain after they are set up.
.. note::
This documentation will get updated with steps what needs to be do... |
admin_manual\configuration_server\email_configuration.rst | .rst | 15,393 | null | utf-8 | .. _email-config:
=====
Email
=====
Nextcloud is capable of sending password reset emails, notifying users of new
file shares, changes in files, and activity notifications. Your users configure
which notifications they want to receive on their Personal pages.
Nextcloud does not contain a full email server, but rathe... |
admin_manual\configuration_server\external_sites.rst | .rst | 2,977 | null | utf-8 | ======================
Linking external sites
======================
You can embed external websites or documents inside your Nextcloud pages with the **External
sites** app, as this screenshot shows.
.. figure:: ../images/external-sites-1.png
*Click to enlarge*
This is useful for quick access to important pages... |
admin_manual\configuration_server\index.rst | .rst | 188 | null | utf-8 | =======================
Nextcloud configuration
=======================
.. toctree::
:maxdepth: 2
:glob:
security_setup_warnings
config_sample_php_parameters
*
|
admin_manual\configuration_server\language_configuration.rst | .rst | 2,292 | null | utf-8 | =================
Language & Locale
=================
Default language
----------------
In normal cases Nextcloud will automatically detect the language of the Web-GUI.
If this does not work properly or you want to make sure that Nextcloud always
starts with a given language, you can set a **default_language** parame... |
admin_manual\configuration_server\logging_configuration.rst | .rst | 14,435 | null | utf-8 | =======
Logging
=======
Use your Nextcloud log to review system status, or to help debug problems. You may adjust logging levels, and choose how and where log data is stored. If additional event logging is required, you can optionally activate the **admin_audit** app.
When ``file`` based logging is utilized, both the... |
admin_manual\configuration_server\oauth2.rst | .rst | 2,287 | null | utf-8 | ======
OAuth2
======
Nextcloud allows connecting external services (for example Moodle) to your Nextcloud.
This is done via ``OAuth2``. See `RFC6749 <https://tools.ietf.org/html/rfc6749>`_ for the
OAuth2 specification.
.. note:: Nextcloud supports only confidential clients.
Add an OAuth2 Application
----------------... |
admin_manual\configuration_server\reverse_proxy_configuration.rst | .rst | 8,347 | null | utf-8 | .. _serverconf_reverseproxy:
=============
Reverse proxy
=============
Nextcloud can be run through a reverse proxy, which can cache static assets such
as images, CSS or JS files, move the load of handling HTTPS to a different
server or load balance between multiple servers.
Defining trusted proxies
----------------... |
admin_manual\configuration_server\security_setup_warnings.rst | .rst | 7,440 | null | utf-8 | ======================
Warnings on admin page
======================
Your Nextcloud server has a built-in configuration checker, and it reports its
findings at the top of your Admin page. These are some of the warnings you
might see, and what to do about them.
.. figure:: ../images/security-setup-warning-1.png
You c... |
admin_manual\configuration_server\text_configuration.rst | .rst | 1,205 | null | utf-8 | ========
Text app
========
Disable rich workspaces globally
--------------------------------
Rich workspaces can be disabled globally by the admin by setting the following config option to 0 (default is 1):
::
occ config:app:set text workspace_available --value=0
Default file extension
----------------------
Th... |
admin_manual\configuration_server\theming.rst | .rst | 3,782 | null | utf-8 | =======
Theming
=======
The theming feature lets you customize the look and feel of your Nextcloud instance to match your organization's design (or - if for personal use - your own style). You can replace the Nextcloud logo and background images with your own assets, customize colors and slogans, and add dedicated leg... |
admin_manual\configuration_user\authentication.rst | .rst | 1,128 | null | utf-8 | .. _authentication:
==============
Authentication
==============
App passwords
^^^^^^^^^^^^^
App passwords allow users to authenticate multiple client applications against their Nextcloud account without giving the application the login password. App passwords are mandatory for accounts with :ref:`two-factor authent... |
admin_manual\configuration_user\index.rst | .rst | 375 | null | utf-8 | ===============
User management
===============
.. toctree::
:maxdepth: 2
user_configuration
reset_admin_password
reset_user_password
user_password_policy
authentication
two_factor-auth
user_auth_ldap
user_auth_ldap_cleanup
user_auth_ldap_api
user_provisioning_api
profi... |
admin_manual\configuration_user\instruction_set_for_groups.rst | .rst | 4,797 | null | utf-8 | ==========================
Instruction set for groups
==========================
Search/get groups
-----------------
Retrieves a list of groups from the Nextcloud server. Authentication is done by
sending a Basic HTTP Authorization header.
**Syntax: ocs/v1.php/cloud/groups**
* HTTP method: GET
* url arguments: sear... |
admin_manual\configuration_user\instruction_set_for_users.rst | .rst | 14,578 | null | utf-8 | =========================
Instruction set for users
=========================
Add a new user
--------------
Create a new user on the Nextcloud server. Authentication is done by sending a
basic HTTP authentication header.
**Syntax: ocs/v1.php/cloud/users**
* HTTP method: POST
* POST argument: userid - string, the re... |
admin_manual\configuration_user\profile_configuration.rst | .rst | 18,932 | null | utf-8 | .. _profile:
========
Profiles
========
The user profile displays information about an account.
Profiles are enabled by default.
Users can enable or disable their own profile in **Personal settings** under
**Personal info**.
As an administrator, you can:
- set the default profile state for new users, and
- disable... |
admin_manual\configuration_user\reset_admin_password.rst | .rst | 940 | null | utf-8 | ===============================
Resetting a lost admin password
===============================
The normal ways to recover a lost password are:
1. Click the password reset link on the login screen; this appears after a
failed login attempt. This works only if you have entered your email address
on your Personal... |
admin_manual\configuration_user\reset_user_password.rst | .rst | 596 | null | utf-8 | =========================
Resetting a user password
=========================
The Nextcloud login screen displays a **Wrong password. Reset it?** message
after a user enters an incorrect password, and then Nextcloud automatically
resets their password. However, if you are using a read-only authentication
backend such ... |
admin_manual\configuration_user\two_factor-auth.rst | .rst | 4,554 | null | utf-8 | .. _two-factor-auth:
=========================
Two-factor authentication
=========================
Two-factor authentication adds an additional layer of security to user accounts. In order to log
in on an account when two-factor authentication (2FA) is enabled, you must provide both the
login password and another fac... |
admin_manual\configuration_user\user_auth_ldap.rst | .rst | 39,203 | null | utf-8 | =============================
User authentication with LDAP
=============================
Nextcloud ships with an LDAP application to allow LDAP users (including Active
Directory) to appear in your Nextcloud user listings. These users will
authenticate to Nextcloud with their LDAP credentials, so you don't have to
cre... |
admin_manual\configuration_user\user_auth_ldap_api.rst | .rst | 26,277 | null | utf-8 | ==========================
The LDAP configuration API
==========================
All methods require that the "OCS-APIREQUEST" header be set to "true". Methods take an optional "format" parameter, which may be "xml" (the default) or "json".
Creating a configuration
------------------------
Creates a new and empty ... |
admin_manual\configuration_user\user_auth_ldap_cleanup.rst | .rst | 4,032 | null | utf-8 | =================
LDAP user cleanup
=================
LDAP User Cleanup is a new feature in the ``LDAP user and group backend``
application. LDAP User Cleanup is a background process that automatically
searches the Nextcloud LDAP mappings table, and verifies if the LDAP users are
still available. Any users that are no... |
admin_manual\configuration_user\user_auth_oidc.rst | .rst | 2,003 | null | utf-8 | =======================================
User authentication with OpenID Connect
=======================================
Nextcloud users can authenticate via an external identity provider.
Nextcloud can also be an identity provider itself.
Authentication in Nextcloud
---------------------------
The `OpenID Connect us... |
admin_manual\configuration_user\user_configuration.rst | .rst | 11,048 | null | utf-8 | ===============
User management
===============
On the User management page of your Nextcloud Web UI you can:
* Create new users
* View all of your users in a single scrolling window
* Filter users by group
* See what groups they belong to
* Edit their full names and passwords
* See their data storage locations
* Vie... |
admin_manual\configuration_user\user_password_policy.rst | .rst | 807 | null | utf-8 | ====================
User password policy
====================
A password policy is a set of rules designed to enhance computer security by encouraging users to employ strong passwords and use them properly.
In the security-section of your administrator-settings you can configure
* a minimal length of a password. De... |
admin_manual\configuration_user\user_provisioning_api.rst | .rst | 1,048 | null | utf-8 | =====================
User provisioning API
=====================
The Provisioning API application enables a set of APIs that external systems can use to create,
edit, delete and query user attributes, query, set and remove groups, set quota
and query total storage used in Nextcloud. Group admin users can also query
N... |
admin_manual\declarations\energy_consumption.rst | .rst | 662 | null | utf-8 | ==================
Energy consumption
==================
The Green Metrics Tool is certified under the `Blue Angel for Software DE-UZ 215 <https://www.blauer-engel.de/en/productworld/software>`_.
This page contains the typical energy consumption according to the Standard Usage Scenarios used in the certification.
In... |
admin_manual\declarations\index.rst | .rst | 102 | null | utf-8 | ============
Declarations
============
.. toctree::
:maxdepth: 2
energy_consumption
|
admin_manual\desktop\index.rst | .rst | 824 | null | utf-8 | ===============
Desktop Clients
===============
Available for Windows, macOS, and various Linux distributions, the Nextcloud
Desktop Sync client enables you to:
- Specify one or more directories on your computer that you want to synchronize
to the Nextcloud server.
- Always have the latest files synchronized, where... |
admin_manual\desktop\massdeployment.rst | .rst | 16,449 | null | utf-8 | ===================================
Desktop Client Deployment and Setup
===================================
This chapter describes administrator-facing deployment and setup options for the Nextcloud Desktop client.
These options are intended for managed rollouts and other administrative scenarios, such as deployment ... |
admin_manual\desktop\troubleshooting.rst | .rst | 15,518 | null | utf-8 | ===============
Troubleshooting
===============
The following two general issues can result in failed synchronization:
- The server setup is incorrect.
- The client contains a bug.
When reporting bugs, it is helpful if you first determine what part of the
system is causing the issue.
Identifying Basic Functionality... |
admin_manual\exapps_management\AdvancedDeployOptions.rst | .rst | 1,525 | null | utf-8 | =======================
Advanced Deploy Options
=======================
.. _ai-app_api_deploy_options:
AppAPI allows optionally to configure environment variables and mounts for the ExApp container.
It is available via "Deploy options" modal next to "Deploy and Enable" button in the sidebar of the ExApp page on the ... |
admin_manual\exapps_management\AppAPIAndExternalApps.rst | .rst | 10,028 | null | utf-8 | ========================
AppAPI and External Apps
========================
.. _ai-app_api:
Previously, Nextcloud only supported applications written in the PHP programming language.
In order to support a wider range of use cases,
an ecosystem for **ExApps** (short for "External Apps") was introduced, allowing for the... |
admin_manual\exapps_management\DeployConfigurations.rst | .rst | 31,640 | null | utf-8 | .. _deploy-configs:
Deployment configurations
=========================
Currently, two kinds of application deployments are supported:
* :ref:`Docker Deploy Daemon (Docker Socket Proxy) <ai-app_api_ddd-dsp>`
* :ref:`Docker Deploy Daemon (HaRP) <ai-app_api_ddd-harp>`
Docker Deploy Daemon
--------------------
... |
admin_manual\exapps_management\index.rst | .rst | 229 | null | utf-8 | =================
ExApps management
=================
.. toctree::
:maxdepth: 2
AppAPIAndExternalApps
DeployConfigurations
ManagingDeployDaemons
TestDeploy
ManagingExApps
AdvancedDeployOptions
|
admin_manual\exapps_management\ManagingDeployDaemons.rst | .rst | 8,997 | null | utf-8 | .. _managing-deploy-daemons:
Managing Deploy Daemons
=======================
OCC CLI
^^^^^^^
There are a few OCC CLI commands to manage Deploy Daemons:
1. Register ``occ app_api:daemon:register``
2. Unregister ``occ app_api:daemon:unregister``
3. List registered daemons ``occ app_api:daemon:list``
Register
------... |
admin_manual\exapps_management\ManagingExApps.rst | .rst | 3,346 | null | utf-8 | Managing ExApps
===============
Managing ExApps can be done from App Management UI as with other Nextcloud Apps,
but you can also use the AppAPI commands in the OCC CLI tool.
There are several commands to work with ExApps:
1. Register
2. Unregister
3. Update
4. Enable
5. Disable
6. List ExApps
Register
--------
Co... |
admin_manual\exapps_management\TestDeploy.rst | .rst | 4,642 | null | utf-8 | .. _test_deploy:
Test Deploy Daemon
------------------
You can test each Daemon configuration deployment from the AppAPI Admin settings.
.. image:: ./img/test_deploy.png
:alt: AppAPI admin settings showing daemon configuration with Test deploy option in three-dots menu
Status Checks
^^^^^^^^^^^^^
The Deploy te... |
admin_manual\file_workflows\access_control.rst | .rst | 5,665 | null | utf-8 | ====================
Files access control
====================
Nextcloud's File Access Control app enables administrators to create and
manage a set of rule groups. Each of the rule groups consists of one or more
rules. If all rules of a group hold true, the group matches the request and
access is being denied. The ru... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.