owncloud-archive / documentation Goto Github PK

the roadmap is outdated. either you update it or delete it on the website and get the information on milestones on github up to date.

all this should be discussed.

attend the post of kiranos: owncloud/core#2639 (comment)

http://owncloud.org/roadmap/

what people (like me) want to know:

what will be fixed in 5.0.1?

what are the goals for 6.0?

what are the long-term goals after that?

when is client-side encryption planned?

within the core repo there is ./autotest.sh which is used to run all unit tests on clean installations on 3 database systems: sqlit, mysql and pgsql

Follow-up issue to apps issue #285 ("Contacts: Colon (":") is incorrectly escaped with Apple CardDAV clients"):

The current sentence on iOS – Synchronize iPhone/iPad about known issues with iOS4 devices is

Problems have been reported for iOS 4.x. A possible solution is at the forum.

It links to a forum post, that describes the necessity to create Apache2 redirects for CardDAV URLs, which both the iOS4 and the Mac OS X Address Book expect to exist, before they even start to work, thus making any configuration attempt fail without them.

The linked forum post was apparently written at the time of ownCloud 3.x and provides the (lighttpd) redirect

url.redirect = (
"^/.well-known/carddav" => "//apps/contacts/carddav.php",
)

Problem: This won't work with ownCloud 4.x anymore, neither with lighttpd, nor (in adapted form) with Apache2.

Solution: A working Apache2 redirect for ownCloud 4 versions would now be

Redirect /.well-known/carddav http://subdomain.domain.tld/owncloud/remote.php/carddav/

or respectively, for SSL-enabled sites,

Redirect /.well-known/carddav https://subdomain.domain.tld/owncloud/remote.php/carddav/

There are of course dozens of ways to accomplish such redirects on Apache2, but I've successfully tested it on a Raspbian-based Raspberry Pi by writing these two redirects into

/etc/apache2/sites-available/default (non-SSL) and
/etc/apache2/sites-available/default-ssl (SSL),

just before the last closing </VirtualHost>-tag. This should work on any Debian-based system accordingly, e.g. Raspbian or Ubuntu, and make the Address Book of iOS4 devices and Macs with Snow Leopard work. Please note that your contacts' data will still get corrupted when being edited on these devices, as their CardDAV clients escape the colon character (":") incorrectly (see apps issue #285 for further details).

https://github.com/owncloud/documentation/blob/master/admin_manual/custom_user_backend.rst

needs should be edited to be closer to the LDAP auth chapter, and contain similarly reliable information.

https://github.com/owncloud/documentation/blob/master/admin_manual/auth_ldap.rst

It should also be named auth_other or split into "auth_imap", "auth_smb", etc. if the amout of content justifies that.

The feature page mentions quite a few nice features.

However, not all of them are fully available ("Galleries" / "Share Your Data" - gallery sharing isn't implemented, see this issue: owncloud-archive/apps#61);
Some are ambiguous: E.g. what is exactly meant by "File Notifications" - is it meant that one can share files via email, or is it meant that users will be notified when a file is shared with them? if the first, doesn't work in 4.5, see this issue: owncloud/core#100; if the latter, how is it configured? ).
What are the new "Application API’s" supposedly introduced with owncloud 4? is it WebDAV/CalDAV/CardDAV? Or is there some other, maybe REST API for accessing owncloud? If so, where to find docs on it?
Or features not working - e.g. Versioning which doesn't work in 4.5.1, see these issues: owncloud/core#101, owncloud/core#148

As it currently stands, this page has the potential to create confusion in new users trying to use the mentioned features... and possibly annoy them once they find out that they don't exist, aren't working as expected, or not documented...

Hi,

the NginX configuration needs some updates because some important parts of the .htaccess file like the rewrite rules are missing. Collected from some forum posts:

http://forum.owncloud.org/viewtopic.php?f=3&t=2952

and from my tests this is the important part of a working configuration for NginX and OwnCloud:

    error_page 403 /core/templates/403.php;
    error_page 404 /core/templates/404.php;

    # default try order
    location / {
            rewrite ^/.well-known/host-meta /public.php?service=host-meta last;
            rewrite ^/.well-known/carddav /remote.php/carddav/ redirect;
            rewrite ^/.well-known/caldav /remote.php/caldav/ redirect;
            rewrite ^/apps/calendar/caldav.php /remote.php/caldav/ last;
            rewrite ^/apps/contacts/carddav.php /remote.php/carddav/ last;
            rewrite ^/apps/([^/]*)/(.*\.(css|php))$ /index.php?app=$1&getfile=$2 last;
            rewrite ^/remote/(.*) /remote.php/$1 last;
            try_files $uri $uri/ @webdav;
    }

    # owncloud WebDAV
    location @webdav {
            fastcgi_split_path_info ^(.+\.php)(/.*)$;
            fastcgi_pass 127.0.0.1:9000; # or use php-fpm with: "unix:/var/run/php-fpm/php-fpm.sock;"
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_param HTTP_AUTHORIZATION $http_authorization;
            fastcgi_param HTTPS on;
            include fastcgi_params;
    }
    # enable php
    location ~ \.php$ {
            try_files $uri = 404;
            fastcgi_pass 127.0.0.1:9000; # or use php-fpm with: "unix:/var/run/php-fpm/php-fpm.sock;"
            fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
            fastcgi_param HTTP_AUTHORIZATION $http_authorization;
            fastcgi_param HTTPS on;
            fastcgi_param htaccessWorking true;
            include fastcgi_params;
    }

The HTTP_AUTHORIZATION is the rewrite of the .htaccess "RewriteRule .* - [env=HTTP_AUTHORIZATION:%{HTTP:Authorization}]". Additionally the fastcgi_param htaccessWorking true; has to be set to show the upload limit button in the admin settings.

As stated here the path for CardDAV-synchronisation is wrong in the OSX documentation.

Futhermore most parts of the documentation are not necessary for OSX 10.7 and 10.8 and should be moved into a seperate paragraph with a clear heading.

The documentation is also missing a step by step-description with screenshots (similar to the KDE-documentation).

I am willing to rewrite this part of the documentation, but I can't see how to achieve it.

The owncloud documentation for setting up windows http://doc.owncloud.org/server/5.0/admin_manual/installation/installation_windows.html needs to have a part added regarding php allowed verbs. The default is only a few, and without changing it to all the install postcheck complains that webdav is not working properly.

Expected behaviour

Owncloud install works after following windows install documentation.

Actual behaviour

Owncloud install post check complains that webdav is not setup properly.

Steps to reproduce

Install Windows
Setup owncloud following the documentation here http://doc.owncloud.org/server/5.0/admin_manual/installation/installation_windows.html
Server configuration

Operating system: Windows 2008 R2

Web server: IIS 7.5

Database: mysql

PHP version: 5.4

ownCloud version: 5.0

I a trying to figure out how to set up a second apps path properly but to no avail. Apps are found but assets (img/css/js) do not work for those apps, because owncloud keeps trying to look them up in its main apps directory.
It would be nice if this feature would be properly documented somewhere.

Hello,

I'm looking for further information about the "New OCS REST API support". I'm intersted in developing a client. I've been looking developer documentation page with no luck.

Thank you.

Best regards,
Guillermo.

http://owncloud.org/releases/ does not list the releases 4.5.8 and 5.0.3.
Instead, it lists 5.0.1 which is supposedly dangerous to use, as stated in [1]

4.5.8 apparently contains security patches, as stated in [2]
Ver. 5.0.2 is not even mentioned (but that might be just as well).

Thanks,

• eroueen

[1] http://forum.owncloud.org/viewtopic.php?f=9&t=9939
[2] http://forum.owncloud.org/viewtopic.php?f=9&t=8981#p21865

What do we support/require?

• Servers: Apache, IIS(?), no Lighttpd, nginx, Hiawatha etc except for community docs
• PHP: 5.3 minimum
• Databases: MySQL, SQLite, PostgreSQL, Oracle, …
• Browsers: IE8+, Chrome, Firefox version?, do Safari or Opera specifically need to be supported?
• Javascript required

cc @Raydiation

See owncloud/core#1728

Add a section to the developers manual that documents the usage of background jobs.

Topics

• When to use background jobs
• how to implement them

Transferred from Bug Genie:
http://bugs.owncloud.org/thebuggenie/owncloud/issues/oc-802

Description:
On http://owncloud.org/install/ you have:

apt-get install apache2 php5 php5-json php-xml php-mbstring php5-zip php5-gd
apt-get install php5-sqlite curl libcurl3 libcurl3-dev php5-curl php-pdo

=== The distribution is not specified. === Would be usefull to provide a list for Stable Debian, Fedora, Stable Cent OS/RedHat, Ubuntu LTS

=== This list looks wrong. === Why should we install a -dev package?

=== Some packages does not exists ===

ks4:~ [1006:100]% lsb_release -a
No LSB modules are available.
Distributor ID: Debian
Description: Debian GNU/Linux 6.0.5 (squeeze)
Release: 6.0.5
Codename: squeeze
ks4:~ [1010:100]% apt-get -s install php5-json php-xml php-mbstring php5-zip php-pdo
NOTE: This is only a simulation!
apt-get needs root privileges for real execution.
Keep also in mind that locking is deactivated,
so don't depend on the relevance to the real current situation!
Reading package lists... Done
Building dependency tree
Reading state information... Done
Note, selecting 'php5-common' instead of 'php5-json'
E: Unable to locate package php-xml
E: Unable to locate package php-mbstring
E: Unable to locate package php5-zip
E: Unable to locate package php-pdo

4 packages does not exists, one has a wrong name.

Same on Ubuntu 12.04 LTS:

sunem:~# lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 12.04 LTS
Release: 12.04
Codename: precise
sunem:~# LC_ALL=C apt-get -s install php5-json php-xml php-mbstring php5-zip libcurl3-dev php-pdo
Reading package lists... Done
Building dependency tree
Reading state information... Done
Note, selecting 'php5-common' instead of 'php5-json'
Note, selecting 'libcurl4-openssl-dev' instead of 'libcurl3-dev'
E: Unable to locate package php-xml
E: Unable to locate package php-mbstring
E: Unable to locate package php5-zip
E: Unable to locate package php-pdo

=== Can't chown data directory not in tar.bz2 === You provide an example to chown a non-existing directory. It confuse users. You does not provide example for config directory.

§2.1 Go into your webserver root or virtualroot and extract owncloud

cd /path/to/your/webserver (/var/www on debian and ubuntu)
tar xjf /path/to/downloaded/owncloud-x.x.x.tar.bz2

If you want to install owncloud at the root of your website:

mv owncloud/* owncloud/.??* .
rmdir owncloud

§2.2

chown -R www-data:www-data config

To install users data in the data directory (default configuration):

mkdir data
chown -R www-data:www-data data

=== mod_headers requirement === Is mod_headers required? The subject is about mod_rewrite and there's not directive in any .htaccess I found.

"

Reproduction steps:
Install owncloud using Debian Squeeze or Ubuntu precise following http://owncloud.org/install/

http://doc.owncloud.org/server/master/developer_manual/app/appframework/javascript.html

We need to add php-xml to the list of soft dependencies for

http://owncloud.org/support/requirements/
http://doc.owncloud.org/server/4.5/admin_manual/installation.html

I spent hours trying to figure out why WebDAV wouldn't work before coming across
an obscure forum post.

@tanghus

Please see the todos in

http://doc.owncloud.org/server/5.0/developer_manual/app/vcategories.html

Hi,

I think it would be great to have the documentation autobuilded by Jenkins and have the PDF artifact preserved.

@DeepDiver1975 I guess that is for you. ;)

http://doc.owncloud.org/server/master/developer_manual/app/appframework/css.html#css-for-apps

There is a "document this" notice

Hi,

i think there is a very important information missing in the documentation:

Since the old files_encryption app was removed from OC5 and the new files_encryption is not included in the final release of OC 5.0 no informations about an Upgrade with encrypted data is available in the documentation. Are there any chances to get some informations about the upgrade path for this from OC 4.5 to OC 5?

When I build html files everything works as expected and I get a standalone html documentation.
But when I build latex files and generating PDF they are almost empty. I get the same result as @DeepDiver1975 at https://ci.tmit.eu/job/ownCloud-Documentation(5.0)/

Has somebody an idea? Or am I doing something wrong?

There is no manual for upgrading or updating in a Windows environment. For most this won't be a problem but for some it will.

Maybe add it?

as of today it seems not straight forward on how to configure smtp properly.

Working examples are a must have.

The "Manual Installation" section on [1] states that the required PHP version for installing OC 5 is 5.3.3 whereas in [2] Mr. Karlitschek states that now, 5.3.4 is required.

(Which by the way prevents an installation on Debian stable - Squeeze, which comes with php 5.3.3)

Please fix; thank you.

[1] http://doc.owncloud.org/server/5.0/admin_manual/installation/installation_source.html
[2] https://github.com/owncloud/administration/blob/master/web-installer/setup-owncloud.php#L49-L51

Not a big issue but the link to the "ownCloud Desktop Client Manual" is broken on this page:
http://doc.owncloud.org/server/5.0/user_manual/files/sync.html

The "Install your own" button in the bottom region of the start page still links to http://owncloud.org/install, which in turn gets redirected to the old documentation at http://owncloud.org/support/install/.

wrong:

public function testAddTwo(){
    $this->assertEquals(addTwo(3), 5);
}

right:

public function testAddTwo(){
    $this->assertEquals(5, addTwo(3));
}

To avoid duplicating - and thus quickly obsoleting - the API docs, they should not be written manually, but generated from the inline docs.
Currently API docs are being generated every day and served at http://api.owncloud.org/ - but the layout doesn't fit in the template in this repo.
I suppose the rst docs will be generated regularly, so the same job could first parse the APIs and generate rst from that.

I don't know if it''s usable for this purpose, but @evert has made a quick'n'dirty MarkDown generator; maybe it could be used as a template for making an rst generator?
https://github.com/evert/phpdoc-md

in /documentation/developer_manual/guidelines.rst, paragraph "Contribution guidelines" , second bullet list item:

The text says "Please check our planning page", the link under "planning page" points to Gitorious, which is obsolete.

I pondered replacing it with http://owncloud.org/dev/roadmap/ , but that page doesn't seem to be much more maintained or up-to-date either.

Currently, documentation says this:
http://doc.owncloud.org/server/4.5/user_manual/files.html#mobile
about the mobile apps.

There are the Android and iOS apps in the app store now, so we should link to them. The links are built into ownCloud already.

We should add a part that says:
"To connect to your ownCloud server with the ownCloud mobile apps, use the base URL and folder only.
example.com/owncloud
No need to add remote.php/webdav as you do for any other WebDAV client.

You may also connect to ownCloud from your phone or tablet via WebDAV. WebDAV Navigator is a good (proprietary) app for Android App, iPhone & BlackBerry. The URL for these is:
example.com/owncloud/remote.php/webdav
"

We should put a line in the installation and configuration documentation for MySQL implementations to create indices in their tables after they are finished implementing the feature.

For MySQL:
alter table oc_properties add index(userid);
alter table oc_properties add index(propertypath);
alter table oc_properties add index(propertyname);

http://owncloud.org/releases/ does not list the release 4.5.8, which contains fixes for XSS vulnerabilities. See Issue 106 [1]

Thank you;

• eroueen

[1] #106

A user just reported some problems while upgrading OC from 4.5.8 to 5.0.0 while using php-apc:

http://forum.owncloud.org/viewtopic.php?f=23&t=9296

I'm not really sure but it could be possible that some old files where still in the php cache after the upgrade. A note about cleaning this cache after an update / upgrade to the guide:

http://doc.owncloud.org/server/5.0/admin_manual/maintenance/update.html

could be useful to prevent such problems.

This is hopefully more a question than a bug report or even feature request:

I couldn't find any mechanism -- except the notification in the admin panel of owncloud administrator accounts -- that notifies one about new owncloud versions. I would appreciate some RSS feed or mailing list to sign up where notifications for updates are posted. If you use owncloud mainly not via the web interface but via sync clients or webDAV and for security reasons don't use an account with admin priviledges for daily use then you don't see the admin panel with a possible update notification very often. Also the option to visit the owncloud page regularly is quite unhandy as it requires remembering to do so.

Is there such a feature with more or less automatic out there anywhere which I didn't find it yet?

"=^" is only supported on lighttd2

as the rest of the documentation points to lighttpd 1.4, I would recommend using

"=~" instead.

Currently, there are

https://github.com/owncloud/documentation/blob/master/developer_manual/unittests.rst

and

https://github.com/owncloud/documentation/blob/master/developer_manual/unit-testing.rst

with conflicting information.

From http://bugs.owncloud.org/thebuggenie/owncloud/issues/oc-1602

Still not entered in documentation.

Description:
The documentation to configure LDAP backend on this link http://owncloud.org/support/ldap-backend/ is not correct if you use LDAPS protocol.

If you activate Use TLS option you must specify the server URI instead of hosname in Host field.

Reproduction steps:
Try to configure LDAP server with TLS following the wiki and backend will not work.
#2 Comment posted by @blizzz Aug 29, 14:20

Actually, if you use ldaps, you must deactivate TLS, because of how PHP initializes the connection. I put it on my To Do list.

Things to consider:

• Bootstrapping script needs documentation. Should that be the preferred way of doing things?
• The Distro notes seem random and we do not know anything about the more exotic distros. I'd rather like to kick those out. What about our distro packages?
• There are different packages for commercial customers and open source users?
• The web server notes should be merged into the installation process.
• We should clearly mention what we support (e.g. Apache) and what were the user "voids his warranty" (e.g. nginx, lighty).
• The different factors of the Apache access security needs to be documented (e.g. .htaccess files in / and /data) for two reasons: To have them documented in the first place, and to make sure tutorials for others servers that do not accept (all aspects of) .htaccess still secure all data

/cc @karlitschek @MTRichards @LukasReschke for more input

The recommended handling of php in nginx includes "try_files $uri =404;", which matches exact file names, so /uploads/somelegal.git/with-malicious-code.php doesn't lead to code execution. Unfortunately that breaks with /remote.php/some-more-path-elements.

The following nginx configuration allows for the try_files test and PATH_INFO to be set correctly. This depend on __internal_path to never be used by owncloud itself.

    error_page 403 = /core/templates/403.php;
    error_page 404 = /core/templates/404.php;

    location /  {
            index index.php;
            try_files $uri $uri/ =404;

            rewrite /.well-known/host-meta /public.php?service=host-meta;
            rewrite /.well-known/carddav /remote.php/carddav/;
            rewrite /.well-known/caldav /remote.php/caldav/;
            rewrite /apps/calendar/caldav.php /remote.php/caldav/;
            rewrite /apps/contacts/carddav.php /remote.php/carddav/;
            rewrite /apps/([^/]*)/(.*\.(css|php))$ /index.php?app=$1&getfile=$2;

            rewrite /remote/(.*)$ /remote.php/$1;
    }

    location ~ ^/(config|data|db_structure\.xml|README) {
            deny all;
    }

    location ~* \.php$ {
            try_files $uri =404;
            fastcgi_pass 127.0.0.1:9000;
            fastcgi_index index.php;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            include fastcgi_params;
            fastcgi_param  PATH_INFO          $path_info;
    }

    location /remote.php/ {
            rewrite /remote.php(/.*)$ /remote.php?__internal_path=$1;
            if ($args ~ (?:^|(&))__internal_path=(.+)($|&)) {
                    set $path_info $2;
            }
    }

Migrated from: owncloud/core#786

The WebDAV documentation (https://github.com/owncloud/documentation/blob/master/user_manual/connecting/webdav.rst) refers to both the old /files/webdav.php and the new /remote.php/webdav URL without any mention as to what OC version uses which URL.

Also the "old" documentation at http://owncloud.org/support/webdav/ still only mentions OC 1&2! Is the documentation on owncloud.org supposed to be replaced by the documentation here at github? If so, shouldn't the old documentation be removed, or at least there should be a prominent hint on where to find current doc! And I guess that's the same for any kind of documentation on owncloud.org... (e.g. I also noticed the wrong/outdated WebDAV URL on http://owncloud.org/support/files/)

Hi,

I want to request an update on nginx documentation here:

http://owncloud.org/support/webserver-notes/

Since to increase the upload file size you have to edit also /etc/php5/fpm/php.ini and increase upload_max_filesize and post_max_size directives.

Important: You have to restart php5-fpm and nginx service in order these changes to be applied.

The new documentation is growing quite rapidly, but still many users know of or find the old documentation, and try to apply it for the current versions; sometimes, this old documentation doesn't apply anymore.

There should be a big, well visible warning sign at the top of the old docs, that there is now new docs available, and where they are!

Add a section to the admin and developers manual that documents the usage of background jobs.

Topics for the admin manual

• Is it required? (no)
• Available backends (ajax, webcron, system cron) with pro/con

Topics for the developers manual

• When to use background jobs
• how to implement them

@MTGap

The sharing API docs need to be reworked: http://doc.owncloud.org/server/5.0/developer_manual/app/share-api.html

Here are the docs for the share class

file:///home/ray/programming/private/documentation/developer_manual/_build/html/org/classes/core/share.html you can reference it with :php:class:OCP\\Share

for more info check http://pythonhosted.org/sphinxcontrib-phpdomain/reference.html

owncloud/core#2011

The section of the 5.0 manual on the Calendar app says:-

 With the advanced options you can set the description, the location
 and the repetition rate of an event. If the repeating should end you
 can choose between setting the end by date or by occurrences. If you
 choose in the weekview all days from Monday to Friday it will
 automatically set the repeat rule to *every weekday*. If the
 interval of the weekview can be devided by two it automatically set
 the repeat rule to *Bi-Weekly*.

However you don't (or at least I don't think you do) need to use the Advanced tab to set a repeating event. It's also not clear what the "interval" setting does i the advanced section of Repeat.

The documentation on here
http://owncloud.org/support/calendars/
states that the default calendar to use in the URL for apps like Thunderbird is default%20calendar
but it is incorrect. It has been changed to defaultcalendar

In the documentation currently there is a mention of adding/changing a registry key for the BasicAuthLevel in [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters]

Unfortunately this is not enough to enable smooth operations with MS Office, one has to add a (user specific) registry key for MS Office too:
[HKEY_CURRENT_USER\Software\Microsoft\Office\14.0\Common\Internet]

Add BasicAuthLevel = 2

Also see Alfresco documentation on this matter:
http://docs.alfresco.com/4.0/index.jsp?topic=%2Fcom.alfresco.enterprise.doc%2Ftasks%2Ftuh-maptodrive.html

This is, at least, valid for ownCloud > 4.5