Git Product home page Git Product logo

docs-server's Introduction

ownCloud Server Documentation

Table of Contents

Building the Server Docs

The ownCloud Server documentation is not built independently. Instead, it is built together with the main documentation. However, you can build a local copy of the ownCloud Server documentation to preview changes you are making.

Whenever a Pull Request of this repo gets merged, it automatically triggers a full docs build.

General Notes

To make life easier, most of the content written in docs applies also here. For ease of reading, the most important steps are documented here too. For more information see the link provided. Only a few topics of this repo are unique like the branching.

Generating the Documentation

See the Generating the Documentation in the docs repo for more details as it applies to all documentation repositories.

Target Branch and Backporting

See the the following section as the same rules and notes apply.

Branching Workflow

Please refer to the Branching Workflow for ownCloud Server for more information.

Create a New Version Branch for ownCloud Server

Please refer to Create a New Version Branch for ownCloud Server for more information.

docs-server's People

Contributors

butonic avatar cdamken avatar chriseds avatar crrodriguez avatar d7oc avatar dependabot[bot] avatar enbrnz avatar eparzefall avatar hodyroff avatar iljan avatar jnweiger avatar jstell avatar kiranparajuli589 avatar mbrembati avatar michaelstingl avatar mmattel avatar mrow4a avatar msteiger avatar nicholas-wilson-au avatar pako81 avatar phil-davis avatar phista7 avatar pmaier1 avatar rzatoc avatar thebignet avatar valentinkruegl avatar voroyam avatar wkloucek avatar xoxys avatar zargontapel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-server's Issues

Improvements on the session handling

WHAT Needs to be Documented?

New config options added in owncloud/core#39916 . Some old options might need an update for clarification

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Hopefully, owncloud/core#39916 (comment) and the information in the config.sample.php file is enough, if not please ask.

This is expected to be in 10.9.2

Client branding "Customize OAuth2 parameters"

WHAT Needs to be Documented?

For what exact do you need these parameters and how to set them (Oauth2, Azure wich is not possible to use dynamic client registration)

WHERE Does This Need To Be Documented (Link)?

I'm not sure if it should be in the branding docs or in the OpenID docs

WHY Should This Change Be Made?

It is possible to hard code the parameters with the ownBrander in the client

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

@d7oc AFIAK you faced some issues here to get this work.

@mmattel

The database username and password in the docker template should be moved to an environment file

WHAT Needs to be Documented?

The page https://doc.owncloud.com/server/next/admin_manual/installation/docker/ contains a template for docker-compose to setup all the stuff required. In general everything which is needed and should be changed is moved to an environment file. This applies to settings like the ownCloud Admin user name and password. The database user name and password is fixed nevertheless and not moved to an environment file. IMHO it would make sense to move that as well to sharpen the awareness that those values should also be changed (even if it's an internal connection).

To sum things up the new template would then look like:

version: "3"

volumes:
  files:
    driver: local
  mysql:
    driver: local
  redis:
    driver: local

services:
  owncloud:
    image: owncloud/server:${OWNCLOUD_VERSION}
    container_name: owncloud_server
    restart: always
    ports:
      - ${HTTP_PORT}:8080
    depends_on:
      - mariadb
      - redis
    environment:
      - OWNCLOUD_DOMAIN=${OWNCLOUD_DOMAIN}
      - OWNCLOUD_DB_TYPE=mysql
      - OWNCLOUD_DB_NAME=owncloud
      - OWNCLOUD_DB_USERNAME=${DATABASE_USERNAME}
      - OWNCLOUD_DB_PASSWORD=${DATABASE_PASSWORD}
      - OWNCLOUD_DB_HOST=mariadb
      - OWNCLOUD_ADMIN_USERNAME=${ADMIN_USERNAME}
      - OWNCLOUD_ADMIN_PASSWORD=${ADMIN_PASSWORD}
      - OWNCLOUD_MYSQL_UTF8MB4=true
      - OWNCLOUD_REDIS_ENABLED=true
      - OWNCLOUD_REDIS_HOST=redis
    healthcheck:
      test: ["CMD", "/usr/bin/healthcheck"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - files:/mnt/data

  mariadb:
    image: mariadb:10.5
    container_name: owncloud_mariadb
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=owncloud
      - MYSQL_USER=${DATABASE_USERNAME}
      - MYSQL_PASSWORD=${DATABASE_PASSWORD}
      - MYSQL_DATABASE=owncloud
    command: ["--max-allowed-packet=128M", "--innodb-log-file-size=64M"]
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-u", "root", "--password=owncloud"]
      interval: 10s
      timeout: 5s
      retries: 5
    volumes:
      - mysql:/var/lib/mysql

  redis:
    image: redis:6
    container_name: owncloud_redis
    restart: always
    command: ["--databases", "1"]
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5
    volumes:
      - redis:/data

and the environment would contain example settings for those values:

cat << EOF > .env
OWNCLOUD_VERSION=10.9
OWNCLOUD_DOMAIN=localhost:8080
ADMIN_USERNAME=admin
ADMIN_PASSWORD=admin
DATABASE_USERNAME=owncloud
DATABASE_PASSWORD=owncloud
HTTP_PORT=8080
EOF

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/installation/docker/

WHY Should This Change Be Made?

This change should be done for security reasons as those changes might be overlooked if not part of the env file.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

configreport application unknown to marketplace -> misleading

WHAT Needs to be Documented?

When following along the 'Generate a Config Report' documentation:

-> Suggests to download the app via the command line
-> using the command:
sudo -u www-data occ market:install configreport
->a misleading information is presented

WHERE Does This Need To Be Documented (Link)?

Here

WHY Should This Change Be Made?

The reason is that after this message is presented some customers don't proceed to check their Apps tab and just assume the marketplace can't provide the application even though it might already be installed and just needs to be enabled.

misleading

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

not sync

WHAT Needs to be Documented?

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

my files can't be updated in owncloud and other users who I'm share with it

LDAP Filter for disabled users

WHAT Needs to be Documented?

&(|(objectclass=organizationalPerson))
  (!(userAccountControl:1.2.840.113556.1.4.803:=2))
  (|(|(memberof=CN=Domain Users,CN=Users,DC=dp,DC=mosreg,DC=ru)(primaryGroupID=513)))
)

There is a bracket too much at the end or a bracket missing at the top

@cdamken

I have this and this works:

(&(|(objectclass=user))
(!(userAccountControl:1.2.840.113556.1.4.803:=2))
(|(memberof=CN=Domain Users,CN=Users,DC=dp,DC=mosreg,DC=ru)(primaryGroupID=513))
)

I find it cleaner with the bracket in front of the first sign, it's also how our own LDAP app does it if you let it on auto configure / wizard.

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/configuration/user/user_auth_ldap.html#filter-out-deactivated-users

WHY Should This Change Be Made?

to make it work and formally correct.

Add php. warnings

WHAT Needs to be Documented?

While upgrading the owncloud, should be consider the php versions too.

WHERE Does This Need To Be Documented (Link)?

https://github.com/owncloud/docs-server/blob/10.9/modules/admin_manual/partials/maintenance/major_release_note.adoc

WHY Should This Change Be Made?

Because the users will upgrade but not know that not all versions from oC works with all versions from php, specially when comming from 7 , 8 and 9

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Attempt to document installation of PHP 7.4 and necessary extensions on Ubuntu 22.04

WHAT Needs to be Documented?

Attempt to document installation of PHP 7.4 and necessary extensions on Ubuntu 22.04.

  1. Install SURY APT Repository: to install PHP 7.4 on Ubuntu 22.04 we will need to install SURY, third party repositories that provides PHP packages (we are going to use the Focal one as Jammy one is not available yet):
sudo add-apt-repository ppa:ondrej/php -y
sed -i 's/jammy/focal/' /etc/apt/sources.list.d/ondrej-ubuntu-php-jammy.list
sudo apt update
  1. Running below command to install PHP7.4:

sudo apt install php7.4

returns an error:

The following packages have unmet dependencies:
 libapache2-mod-php7.4 : Depends: php7.4-cli but it is not going to be installed
                                             Depends: libssl1.1 (>= 1.1.0) but it is not installable
                                             Recommends: apache2 but it is not going to be installed
 php7.4-common : Depends: libssl1.1 (>= 1.1.0) but it is not installable

Problem —> In Ubuntu 22.04 libssl1.1 has been superseded by libssl3 and therefore following error is returned
Solution —> download libssl1.1 package from http://security.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.12_amd64.deb and install it manually by running

sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.12_amd64.deb

  1. Install additional required modules:
sudo apt install php7.4-mysql, php7.4-mbstring, php7.4-redis, php7.4-imagick, php7.4-igbinary, php7.4-gmp, php7.4-bcmath, php7.4-curl, php7.4-gd, php7.4-zip, php7.4-imap, php7.4-ldap, php7.4-bz2, php7.4-ssh2, php-phpseclib, php7.4-common, php7.4-json, php7.4-xml, php7.4-dev, libsmbclient-dev, php-pear
  1. Running below command to install the php7.4-intl package:

apt install php7.4-intl

returns an error:

The following packages have unmet dependencies:
 php7.4-intl : Depends: libicu66 (>= 66.1-1~) but it is not installable

Problem —> In Ubuntu 22.4 libicu70 package is available
Solution —> download libicu66 package from http://security.ubuntu.com/ubuntu/pool/main/i/icu/libicu66_66.1-2ubuntu2.1_amd64.deb and install it manually by running

sudo dpkg -i libicu66_66.1-2ubuntu2.1_amd64.deb

  1. Use the following commands to install some common prerequisites:
sudo apt install smbclient
sudo apt install redis-server
sudo apt install unzip
sudo apt install openssl
sudo apt install rsync
sudo apt install imagemagick
  1. Prevent the two manually installed packages from steps above to be upgraded when running the apt upgrade command by setting them on hold:

sudo apt-mark hold libssl1.1 libicu66

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/10.9/admin_manual/installation/manual_installation/server_prep_ubuntu_20.04.html#clean-ubuntu-20-04-installation

WHY Should This Change Be Made?

Enterprise distros are not ready to deliver PHP 8.x soon therefore this is an attempt to have oC running with PHP 7.4 for Ubuntu 22.04 users

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

LDAP recursive group membership and AD

WHAT Needs to be Documented

General recursive group membership information for AD and / or Samba AD, as requested in owncloud/user_ldap#683 (comment)

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

@mmattel

Shibboleth users cannot impersonate

Setup

Steps

  • using admin (from database backend): impersonating works
  • using a user from the Shibboleth backend (users provisioned from the backend): I cannot impersonate; it says "Can not impersonate" /"Als fremder Benutzer ausgeben fehlgeschlagen"

Expected result
I want every user of the group "admin" to be able to impersonate, independently of the user backend

There is no related output in the logs (loglevel: DEBUG)

[QA] new features in upcoming customgroups 0.7.0

WHAT Needs to be Documented?

WHERE Does This Need To Be Documented (Link)?

?
https://github.com/owncloud/docs-server/blob/74e2c78c3f6d3c461cb405ddfb5a75c55a93f075/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc
https://github.com/owncloud/docs-server/blob/327cfb321333291b507cefbcbe066df62dab00d3/modules/admin_manual/pages/configuration/user/user_management.adoc
...?

WHY Should This Change Be Made?

maybe

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

background_jobs_configuration.adoc correction

WHAT Needs to be Documented?

Background Jobs Configuration

WHERE Does This Need To Be Documented (Link)?

n/a

WHY Should This Change Be Made?

Seems like an error

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

In background_jobs_configuration.adoc there is this line:
For example, to run a Cron job on a *nix system every 15 minutes (recommended), under the default web server user (often, www-data or wwwrun) you must set up the following Cron job to call the occ background:cron command:

I think that should not be background:cron but system:cron as in the example below the line. The background:cron command is to set the configuration to cron mode and is explained in the beginning of the page.

Instructions for creating a new doc branch is unclear

Step1, Item 8 at https://github.com/owncloud/docs-server/blob/master/docs/new-version-branch.md?plain=1#L16
mentions modules/ROOT/pages/server_releases.adoc
which is not in this repo. (There is one in docs, but that one ends at 10.7 )

I've skipped this item for creating https://github.com/owncloud/docs-server/tree/10.10 --
yarn antora neverthless ran fine here.

I'd guess, I now need to do two PRs, one for docs-server, and one for docs and sort the items into the two repos as they fit best. I am stopping before step 2 to avoid more chaos.

[QA] Manual copy / paste misses redirects

Seen in https://doc.owncloud.com/server/next/admin_manual/installation/quick_guides/ubuntu_20_04.html#set-up-a-cron-job

User tries to highlight the code with the mouse, Everything except the > character can be highlighted.

image

When the result is pasted, the command fails with an error message of

bash: /var/spool/cron/crontabs/www-data: Permission denied

Something is rotten in the state of Antora.

Backports needed.

FYI: @emma1382 this is what happened to you :-)

Database backup command misses transaction parameter

WHAT Needs to be Documented?

The backup section at https://doc.owncloud.com/server/next/admin_manual/installation/docker/#upgrading-owncloud-on-docker describes a backup using

/usr/bin/mysqldump -u root --password=owncloud \
     owncloud > owncloud_$(date +%Y%m%d).sql

This command missed the transaction parameter --single-transaction which instructs mysqldump to execute the backup job in a single transaction on the database layer so that no other operation in between can lead to an inconsistent backup state. See https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#option_mysqldump_single-transaction
If there is binary data in the database it would also be recommended to add --hex-blob see https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#option_mysqldump_hex-blob

WHERE Does This Need To Be Documented (Link)?

In my opinion at least --single-transaction should be added

WHY Should This Change Be Made?

Without the parameter the mysqldump might be in an inconsistent state if another service still adds data.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Transferring Files to Another User //Specification

WHAT Needs to be Documented?

Current Documentation

CLICK ME

You may transfer files from one user to another with occ. The command transfers either all or a limited set of files from one user to another. It also transfers the shares and metadata info associated with those files (shares, tags, and comments, etc). This is useful when you have to transfer a user’s files to another user before you delete them.

New suggested Documentation

CLICK ME NEXT

You may transfer files from one user to another with occ. The command transfers either all or a limited set of files from one user to another. It also transfers the outgoing shares and metadata info associated with those files (shares, tags, and comments, etc). This is useful when you have to transfer a user’s files to another user before you delete them.

WHERE Does This Need To Be Documented?

Right here

WHY Should This Change Be Made?

-to be more specific to our users
-conflicts with other documentations where we wrote it as in Source 1 or Source 2
-Source 1
-Source 2

Update the part 'How to Create and Configure Microsoft OneDrive'

WHAT Needs to be Documented?

How to use Microsoft OneDrive as an external storage option in ownCloud needs to be updated.

WHERE Does This Need To Be Documented (Link)?

How to create and configure Microsoft OneDrive

WHY Should This Change Be Made?

The Create an application configuration part is outdated. Application Registration Portal is no longer available and user needs to go through Azure Portal to create apps.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

update script owncloud_prep.sh mentioned in the documentation deletes data directory during an upgrade

WHAT Needs to be Documented?

The update script owncloud_prep.sh mentioned in the documentation does not work as expected.

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/installation/manual_installation/script_guided_install.html#creating-the-scripts

WHY Should This Change Be Made?

While performing an upgrade it deletes data directories. This obviously causes data loss. An upgrade should not delete existing data.

(Optional) What Type Of Content Change Is This?

  • Bug Fix to Existing Content

Please correct the script to handle upgrades properly.

(Optional) Which Manual Does This Relate To?

  • Admin Manual

Owncloud was not updating from version 10.9 tot 10.10 using the web interface or the command line interface occ. An attempt was made to update manually using the scripts mentioned in the documentation.

The tar.bz2 file was downloaded from here: https://download.owncloud.com/server/stable/owncloud-latest.tar.bz2

sudo -uwww-data ./occ maintenance:mode --on
./instance.sh
Do you want to secure your .htaccess files post installing/upgrade (y/N)? N
Do you want to install a new instance (y/N)? N
Do you want to upgrade an existing installation (y/N)? Y
Use links for data and apps-external directories (Y/n)? N
Do you want to chmod/chown these links (y/N)? N
Please specify the tar file to extract with full path: /home/user/2022/owncloud-latest.tar.bz2
sudo -u www-data ./occ upgrade

The data directory has to be restored manually.

sudo -uwww-data ./occ maintenance:mode --off

The upgrade seemed to work, but it is unclear if something is broken as a result of this bug.

[QA] specify ldap quota syntax

WHAT Needs to be Documented?

Neither the ldap app itself, nor the docs explain how to specify a quota.
The only source I could find is https://github.com/valerytschopp/owncloud-ldap-schema/blob/master/owncloud.ldif#L6
I believe quota is a string value, starting with numerical digits, followed by whitespace, followed by either GB, MB, ... as a unit.
TODO: find out if

  • decimal places with dot or comma are allowed
  • whitespace is optional,
  • upper/lower case of units matters.

WHERE Does This Need To Be Documented (Link)?

https://github.com/owncloud/docs/blob/master/modules/admin_manual/pages/configuration/user/user_auth_ldap.adoc

WHY Should This Change Be Made?

Admin has to guess syntax otherwise. He should not.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • see above link
  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

[QA] Two new virus scanners added to files_antivirus

WHAT Needs to be Documented?

diff --git a/README.md b/README.md
index 5fa771f..1d1b2c1 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,24 @@ NOTE: The older versions of KAV did not send back the virus/infection name in an
 In v2.0.0 the header to transport the virus can be configured. Default: No header is sent.
 see https://support.kaspersky.com/ScanEngine/1.0/en-US/201214.htm
 
+
+### Run with FortiSandbox in ICAP Mode
+
+Select 'Fortinet' from the dropdown.
+
+The request service for FortiSandbox has to be set to 'respmod' and the response header to 'X-Virus-Name'.
+
+Fortinet privides some Demoinstances of the FortiSandbox, please have a look at the [productpage](https://www.fortinet.com/de/products/sandbox/fortisandbox) from Fortinet.
+
+
+### Run with McAfee Web Gateway 10.x and higher in ICAP Mode
+
+Select 'McAfee Web Gateway 10.x and higher' from the dropdown.
+
+The request service for McAfee has to be set to 'respmod' and the response header to 'X-Virus-Name'.
+
+McAfee provides Demoversions with limited Runtime for evaluation purposes. Have a look at [the McAfee Webpage](https://www.skyhighsecurity.com/en-us/products/secure-web-gateway.html) for the Web Gateway.
+

WHERE Does This Need To Be Documented (Link)?

https://github.com/owncloud/docs-server/edit/master/modules/admin_manual/pages/configuration/server/virus-scanner-support.adoc

WHY Should This Change Be Made?

new features

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Backports to 10.9 and 10.10 please

User Authentication Arcana

WHAT Needs to be Documented?

The Admin GUI of user_ldap is weird

WHERE Does This Need To Be Documented (Link)?

Admin Manual, new section "hidden secrets - things you never wanted to know, but we have to tell you"

WHY Should This Change Be Made?

owncloud/user_ldap#672 (comment)

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

http.cookie.samesite inconsistency

WHAT Needs to be Documented?

When looking to several documents like OIDC, Azure and MS-OFFICE-WOPI the http.cookie.samesite shows different values which are not consistent - this may confuse readers. Used values are none and lax.

We should agree on one value and note if possible an alternative one.

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

Reduce Confusion

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

@tbsbdr @DeepDiver1975

[QA] external storage with password in config file does not work as documented

Seen in 10.9.1

https://github.com/owncloud/docs-server/edit/master/modules/admin_manual/pages/enterprise/external_storage/enterprise_only_auth.adoc

says, that for the feature
image

config.php should have an entry like

'ftpcred' => [ 'password' => 'ftp123456data' ],

That does not work. A much simpler form works instead:

'ftpcred' => 'ftp123456data',

Passwords per host work with
image

and

'ftpcred2' => [ 'localhost' => 'ftp123456data' ],

[QA] configreport is not mentioned under reporting

WHAT Needs to be Documented?

configreport app is currently only mentioned under
https://doc.owncloud.com/server/next/admin_manual/troubleshooting/providing_logs_and_config_files.html#generate-a-config-report

It should remain there, but also be added under reporting, no?

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/enterprise/reporting/

WHY Should This Change Be Made?

its missing.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Reference an attachment with link: / xref: using the Antora resource ID

WHAT Needs to be Documented?

NOTE:

With Antora 2.3, you can’t reference an attachment with link: using an Antora resource ID.
You have to use link:{attachmentsdir}.
xref an attachment is not supported at all, see When is the family coordinate required in Antora 2.3

With Antora 3, we can change link to xref and use the normal family coordinate attachment$, see: Family coordinates in Antora 3

Check if a Repo is affected:

  • Change into the repo/modules directory
  • run: grep -rn 'link:{attachmentsdir}'

WHERE Does This Need To Be Documented (Link)?

Example: at modules/developer_manual/pages/testing/unit-testing.adoc
We have to check both the admin and developer manual.

A command to do this exchange starting from the modules directory would be like:
find ./ -type f -exec sed -i 's/link:{attachmentsdir}/xref:attachment$/g' {} \;

WHY Should This Change Be Made?

Necessary with Antora 3

[QA] search_elastic 2.2.0 has a new admin UI

WHAT Needs to be Documented?

image

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/configuration/search/

WHY Should This Change Be Made?

It differs from
image

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

[QA] updatenotification of server 10.7.0 fails to point to 10.8.0 changelog

Seen in 10.7.0

The updater section in the web UI refers to the Changelog with the i icon. https://owncloud.org/changelog/#latest10.8

image

We no longer serve this URL, although 10.7.x and 10.8.x servers are still out there.
the new URL is https://owncloud.com/changelog/server/#10.8.0
In 10.9.1 we use correctly use this schema. But we cannot update old servers before they update.

I suggest to add a redirect to forward the old URL to the new URL.

Share API response added new field share_with_user_type

WHAT Needs to be Documented?

With the PR owncloud/core#40013 we emit a new field called share_with_user_type
which might either be 0 = user or 1 = guest

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/developer_manual/core/apis/ocs-share-api.html#response-attributes-2

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Full text search not fully documented

WHAT Needs to be Documented?

Missing admin information from https://github.com/owncloud/search_elastic e.g. App Mode

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/latest/admin_manual/configuration/general_topics/search.html

WHY Should This Change Be Made?

Because it's missing,

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

config.apps.sample needs an update when openidconnect PR gets merged

WHAT Needs to be Documented?

config.apps.sample via core (config-to-docs run)

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

Referencing: owncloud/openidconnect#243 (feat: JWT token will always be used for user info, expiry and verification)

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

@jnweiger @DeepDiver1975 fyi

Description of step 6 in Azure OIDC configuration could be improved

WHAT Needs to be Documented?

On https://doc.owncloud.com/server/10.9/admin_manual/configuration/user/oidc/ms-azure-setup.html step 6 describes: "Go to Authentication Configure Web Redirect URI and setup your Redirect URI.". But there is no such point in the UI. You need to click on "Add a platform" on the platform configuration so that the configure web sub page pops up, see

Screenshot 2022-04-27 at 18 14 27

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/10.9/admin_manual/configuration/user/oidc/ms-azure-setup.html

WHY Should This Change Be Made?

The current explanation is not exact and forces the user to search around.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

The description how to mount Dropbox needs an update

WHAT Needs to be Documented?

The description how to mount Dropbox needs an update, because of changes at Dropbox, the current description is not working without the suggested changes from the referenced issue.

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/configuration/files/external_storage/dropbox.html#create-a-dropbox-app

WHY Should This Change Be Made?

See: Dokumentation externer Speicher-Dropbox

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

@NannaBarz fyi

Public link share of a single file can now have edit access

WHAT Needs to be Documented?

See core PR owncloud/core#40264
"feat: allow editing of public link shared single files"

This will be released in core 10.11 - so no backporting of docs needed.

WHERE Does This Need To Be Documented (Link)?

TBD - I will look

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Docker documentation mentions php occ command

WHAT Needs to be Documented?

The documentation at https://doc.owncloud.com/server/10.9/admin_manual/installation/docker/ still mentioned the php occ command instead of occ as written on https://doc.owncloud.com/server/next/admin_manual/installation/docker/.

WHERE Does This Need To Be Documented (Link)?

On https://doc.owncloud.com/server/10.9/admin_manual/installation/docker/

WHY Should This Change Be Made?

Calling occ via php occ will lead to errors

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Update guests app

WHAT Needs to be Documented?

The guest app needs an update, see owncloud/guests#495 (allow setting share block domains in admin panel)

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/10.9/admin_manual/configuration/user/guests_app.html

WHY Should This Change Be Made?

App update

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Command to delete orphaned previews/thumbnails

WHAT Needs to be Documented?

New command and BG job created with:

owncloud/core#40045 (feat: previews are physically deleted from disk and db in an async manner)

WHERE Does This Need To Be Documented (Link)?

occ command reference
occ List Queued Backgroundjobs
background jobs configuration

WHY Should This Change Be Made?

New command added

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

`S3 Compatible Object Storage as Primary Storage Location` does not provide instructions how to comply with its "before the first login of any user – including the admin user" bootstrap constraint

S3 Compatible Object Storage as Primary Storage Location reads, in pertinent part:

Read the following implications carefully BEFORE you start using files_primary_s3:

  1. Apply this configuration before the first login of any user – including the admin user; otherwise, ownCloud can no longer find the user’s files.

It provides zero instructions how to do this. The Amazon S3 docs that appear in the same section show only how to use the admin interface (presumably after the admin logs in) to configure anything. Further, there are no instructions how to install the app in the first place, and the likely path of discovery of the app in the first place is after the admin logs in.

It's likely technically possible to comply with this requirement, but it's onerous. The reader is left to guess at how they might accomplish it, and probably only after they've violated the constraint. It would be best to provide an approach that allowed the admin user to log in long enough to install and configure the app and then migrate after the fact. An alternative would be to either link to or more explicitly describe how to meet this requirement directly, but the requirement isn't likely reasonable in the first place. It means that admins can't ever add S3 storage as primary unless it is contemplated from the very beginning of an installation, which is likely very rare.

Wrong owner of "apps" folder after doing manual upgrade

WHAT Needs to be Documented?

Following the manual update steps on "Manual ownCloud Upgrade" lead to a non-writeable "apps" folder

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/admin_manual/maintenance/upgrading/manual_upgrade.html

WHY Should This Change Be Made?

Because updating apps is not possible any more after upgrading.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • [X ] Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • [X ] Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Fix: Change the lines

Set the ownership for all files and folders to www-data:www-data for the config and data directory. Note that it is not mandatory to set the ownership of the data/ directory as it should already have the correct ownership and it can take a while to finish, depending on the size:

sudo chown -R www-data:www-data /var/www/owncloud/config
sudo chown -R www-data:www-data /var/www/owncloud/data

to

Set the ownership for all files and folders to www-data:www-data for the config and data directory. Note that it is not mandatory to set the ownership of the data/ directory as it should already have the correct ownership and it can take a while to finish, depending on the size:

sudo chown -R www-data:www-data /var/www/owncloud/config
sudo chown -R www-data:www-data /var/www/owncloud/data
sudo chown -R www-data:www-data /var/www/owncloud/apps

[QA] describe expectatins about expiry notifications

WHAT Needs to be Documented?

When a share expires, activity notifications happen and mail is sent. We no longer expose the exact time of the expiry only the day
to the end user.

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

Was overly specific, causing confusion.
Suggestion see https://github.com/owncloud/enterprise/issues/5227#issuecomment-1231809084

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Update pgsql system requirements

WHAT Needs to be Documented?

In issue https://github.com/owncloud/enterprise/issues/5064 we are doing testing to confirm that later pgsql major versions work OK with oC10. After that testing is complete, we need to update the system requirements matrix to include whatever pgsql versions are confirmed to work.

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

[QA] User manual is not listed in https://doc.owncloud.com/server/latest

http://doc.owncloud.com/server/latest only lists

  • Admin Manual
  • Developer Manual

Expected behaviour:

  • User Manual

should also be there.

The redirect https://doc.owncloud.com/server/latest/user_manual brings me to https://doc.owncloud.com/webui/next/classic_ui/
This is a hint, that the classic User Manual no longer exists?

I am worried, that a user who wants to learn about concept topics like e.g. apps ecosystem or sharing would not expect that info under: User Interfaces -> Web

API responses when setting permissions for public links

WHAT Needs to be Documented?

Referencing: owncloud/core#39194 (Unify API responses when setting permissions for public links)

@phil-davis I hope you do not mind that I have assigned you this issue 😄

WHERE Does This Need To Be Documented (Link)?

Developer documenation

WHY Should This Change Be Made?

Update of content

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

openidconnect: Account info auto-update

WHAT Needs to be Documented?

References: owncloud/openidconnect#222 (Account info auto-update)

When merged, a new functionality is added that needs documentation in the config.apps sample documentation that will finally end up in https://doc.owncloud.com/server/10.10/admin_manual/configuration/server/config_apps_sample_php_parameters.html#app-openid-connect-oidc

Note that post merging those changes in core, we need to do a config-to-docs run in docs to transport the changes to docs.

This PR is the doc central point for this change and all PR's necessary will be referenced here.

WHERE Does This Need To Be Documented (Link)?

The change is needed to be done in core !! as config.sample files are origined in master.

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Missing information within the Theming ownCloud page

WHAT Needs to be Documented?

Step 10 within Quick Start states "Exclude your new theme from integrity checking" and then includes some PHP code. There is no indication of where this code should go. Although this is most likely meant for config.php anyone reading the instructions will not know this at the onset.

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/10.10/developer_manual/core/theming.html

WHY Should This Change Be Made?

To include missing information.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

How to configure pollinterval capability to control desktop and iOS app

WHAT Needs to be Documented?

How to configure pollinterval capability

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/admin_manual/

WHY Should This Change Be Made?

It's currently not documented

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Related:

Document use of expected-failures files in acceptance tests

WHAT Needs to be Documented?

Acceptance tests can be run with an expected-failures file. That file records tests that are known to be failing, and links to related issues. Document the test workflow of how we make use of that.

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/next/developer_manual/testing/acceptance-tests.html

WHY Should This Change Be Made?

Help developers to know what is the current workflow for acceptance tests.

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Redis on Ubuntu 22.04 + PHP 7.4

Related to #366

In https://doc.owncloud.com/server/10.10/admin_manual/configuration/server/caching_configuration.html we document:

The default shipped Redis version and the php-redis extension for Ubuntu 20.04 is 5.x. With Redis version 6, a new authentication mechanism has been introduced named ACL (Access Control Lists). ownCloud does not currently support Redis ACL´s, but does support the password protection available with current Redis versions.

However, the default shipped Redis version for Ubuntu 22.04 is 6.0.16 while the php7.4-redis extension from ondrej/php PPA is 5.3.7 --> we need to be sure that this combination does not cause any issues.

In my test environment, Redis seems to work correctly and no warning are displayed in the General Section of the Admin Page once Redis has been configured for Transactional File Locking.

@mmattel @phil-davis @jnweiger

Documentation for encryption unclear in terms of post encryption on a production systems

WHAT Needs to be Documented?

Enabling the encryption on a production system is not very clear about the conditions.
It should be stated very clear, that this is a risky process.

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/10.8/admin_manual/configuration/files/encryption/encryption_configuration.html
https://doc.owncloud.com/server/10.8/admin_manual/configuration/files/encryption/encryption_configuration_quick_guide.html

WHY Should This Change Be Made?

We do not recommend enabling encryption on a production system and should clearly state that out.
If it should be enabled on a production system, various preconditions need to be full filled.
E.g.
Disable Ransomware Protection
Disable file_antivrus
Make sure the storage has enough space
Run a file scan before starting the encryption

There might be still other condition that can cause a failing of the encryption process which leaves the files in an undefined state. As this highly depends on the system, data and infrastructure, general statements are hard to make.
But at least it should be stated out, that a failed encryption process, destroyed the instance!

Customers trying to achieve that, also need to make sure that they have to have a proper backup to jump back if anything fails.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.