khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #433 from owncloud/fix-broken-sphinx

Browse Source 
Fix broken sphinx
This commit is contained in:
Morris Jobke
2014-07-16 22:44:16 +02:00
parent 6ca19be8cd 8652bf018f
commit 7efb77cff3
8 changed files with 68 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
_shared_assets/themes/owncloud_org/static/styles.css
View File

@@ -28,6 +28,9 @@ a:hover, a:active {
li.next {
float: right;
}
.page-content img {
max-width: 100%;
}
@media (min-width: 1200px) {
.banner ul#menu-header.nav>li:not(.menu-install)>a {
@@ -197,7 +200,7 @@ div.thumbnail > img {
.banner ul#menu-header.nav>li.menu-commercial>a{
border-bottom: 2px solid #e8733b;
}
.banner ul#menu-header.nav>li:not(.menu-install) >a:hover {

22
admin_manual/installation/installation_windows.rst
View File

@@ -1,6 +1,5 @@
Windows 7 and Windows Server 2008
---------------------------------
.. _installationserverwindows:
.. note:: You must move the data directory outside of your public root (See advanced install settings)
@@ -54,7 +53,7 @@ To activate IIS on Microsoft Windows 7:
**Windows Features required for ownCloud on Windows 7**
6. Because a running FTP server is not required, turn off that feature for your server.
6. Because a running FTP server is not required, turn off that feature for your server.
7. Ensure that you have the IIS Management Console.
@@ -62,10 +61,9 @@ To activate IIS on Microsoft Windows 7:
8. Check the CGI checkbox under ``Application Development Features`` in order to enable PHP on IIS.
9. Turn off WebDAV publishing to avoid conflicts between the Windows WebDAV and the ownCloud WebDAV interface.
9. Turn off WebDAV publishing to avoid conflicts between the Windows WebDAV and the ownCloud WebDAV interface.
.. note:: This feature might already be turned off for you. However, we recommend that you ensure that it remains off. The common HTTP
features are the features you would expect from a web server.
.. note:: This feature might already be turned off for you. However, we recommend that you ensure that it remains off. The common HTTP features are the features you would expect from a web server.
After implementing the selections on this page, IIS serves up a web page.
@@ -73,9 +71,9 @@ features are the features you would expect from a web server.
11. Select your website.
On the far right side of the opening page you will see a section titled :guilabel:`Manage Server`.
On the far right side of the opening page you will see a section titled :guilabel:`Manage Server`.
12. Make sure that the service is started, or click :guilabel:`Start` to start the services selected.
12. Make sure that the service is started, or click :guilabel:`Start` to start the services selected.
13. Go to a web browser and navigate to http://localhost.
@@ -147,7 +145,7 @@ To install MySQL on your Windows machine:
1. Use your browser to migrate to http://dev.mysql.com/downloads/.
2. Download the latest community edition for your operating system, choosing either the 32 or 64 bit version as applicable.
2. Download the latest community edition for your operating system, choosing either the 32 or 64 bit version as applicable.
3. Download the **MSI Installer** to assist with the install.
@@ -198,7 +196,7 @@ Installing ownCloud
4. To enable write access to the ownCloud directory to the ownCloud server, navigate your windows explorer to **inetpub/wwwroot/owncloud** (or the installation directory you selected).
5. Right click and select properties.
5. Right click and select properties.
6. Click the security tab, and select the button “to change permissions, click edit”.
@@ -211,7 +209,7 @@ Continue by following the :doc:`installation_wizard`. Select MySQL as the databa
Ensure Proper HTTP-Verb Handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
IIS must pass all HTTP and WebDAV verbs to the PHP/CGI handler, and must not attempt to handle them by itself or syncrhonizing with the Desktop and Mobile Clients will fail.
IIS must pass all HTTP and WebDAV verbs to the PHP/CGI handler, and must not attempt to handle them by itself or syncrhonizing with the Desktop and Mobile Clients will fail.
To ensure your configuration is correct:
@@ -250,7 +248,7 @@ To adjust the maximum upload size, open the ``PHP.ini`` file in a text editor, f
You can make other changes in the ``PHP.ini`` file (for example, the timeout duration for uploads). However, most default settings in the **PHP.ini** file should function appropriately.
To enable file uploads on the web server larger than 30 MB, you must also change some settings in the IIS manager.
To enable file uploads on the web server larger than 30 MB, you must also change some settings in the IIS manager.
To modify the IIS Manager:
@@ -264,7 +262,7 @@ To modify the IIS Manager:
A window opens displaying a number of tabs across the top.
4. Select :guilabel:`Edit Feature Settings`
4. Select :guilabel:`Edit Feature Settings`
5. Modify the :guilabel:`Maximum allowed content length (bytes)` value to 4.1 GB.

10
admin_manual/installation/installation_wizard.rst
View File

@@ -33,8 +33,6 @@ whenever you want to configure something for your ownCloud instance.
Advanced Options
~~~~~~~~~~~~~~~~
.. _advancedoptions:
* Advanced settings are available for configuring a different database or data
directory than the default ones.
@@ -42,7 +40,7 @@ Advanced Options
recommended to configure the data directory to a location outside of
the document root. Otherwise all user data is potentially publicly
visible!
* Show these additional options by clicking on "Advanced":
.. image:: images/install-wizard-advanced.png
@@ -98,8 +96,8 @@ Note
~~~~
ownCloud will take the URL used to access the Installation Wizard and insert
that into the config.php file for the ‘trusted_domains’ setting.
All needed domain names of the owncloud server go into the
'trusted_domains' setting. No domain names of clients go there.
All needed domain names of the owncloud server go into the
'trusted_domains' setting. No domain names of clients go there.
Users will only be able to log into ownCloud when they point their browsers to a
domain name listed in the ‘trusted_domains’ setting. An IPv4 address can be
@@ -110,7 +108,7 @@ as it sends the correct X-Forwarded-Host header.
It should be noted that the loopback address, '127.0.0.1', is whitelisted and
therefore users on the ownCloud server who access ownCloud with the loopback
interface will be able to successfully login.
interface will be able to successfully login.
In the event that an improper URL is used, the
following error will appear:

1
admin_manual/maintenance/backup.rst
View File

@@ -1,6 +1,5 @@
Backing up ownCloud
===================
.. _backingupowncloud:
To backup an ownCloud installation there are three main things you need to retain:

65
admin_manual/maintenance/update.rst
View File

@@ -1,16 +1,15 @@
Updating ownCloud
-----------------
.. _updatingowncloud:
.. _'Updating ownCloud':
The Updater app provides a more automated method of updating ownCloud. To use the Updater app, it must be enabled in your ownCloud instance. The Updater is enabled in your ownCloud instance by default when you install.
The Updater app provides a more automated method of updating ownCloud. To use the Updater app, it must be enabled in your ownCloud instance. The Updater is enabled in your ownCloud instance by default when you install.
To update ownCloud:
1. Make a backup of the ownCloud folder and the database.
See :doc:`backup` for details.
.. note:: To update ownCloud, the Updater app must be enabled in your ownCloud instance. The Updater app is enabled in your ownCloud instance by default when you install. However, to verify that it is enabled, or to enable the Updater app, see `Enabling the Updater App`_.
.. note:: To update ownCloud, the Updater app must be enabled in your ownCloud instance. The Updater app is enabled in your ownCloud instance by default when you install. However, to verify that it is enabled, or to enable the Updater app, see enablingupdaterapp_.
1. Make a backup of the ownCloud folder and the database. See :doc:`backup` for details.
2. Navigate to the 'Admin' page.
@@ -23,20 +22,18 @@ a full upgrade to update to the latest point release (see below).
Verifying the Updater App is Enabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _verifyingupdaterapp:
However, to verify that the Updater is enabled in your ownCloud instance:
1. Select the "Admin" option from the "Personal Settings" dropdown menu.
.. figure:: ../images/oc_personal_settings_dropdown_admin.png
2. Scroll down the resulting web page. If the Updater app appears in this window, the app is enabled. If not, then you must enable it. See enablingupdaterapp_.
2. Scroll down the resulting web page. If the Updater app appears in this window, the app is enabled. If not, then you must enable it. See `Enabling the Updater App`_.
Enabling the Updater App
^^^^^^^^^^^^^^^^^^^^^^^^
.. _enablingupdaterapp:
.. _`Enabling the Updater App`:
The Updater app is enabled in your ownCloud instance by default when you install. However, it is possible that it was disabled at some point. To enable the Updater app:
@@ -54,7 +51,7 @@ The Updater app is enabled in your ownCloud instance by default when you install
**Selecting the Updater app**
3. In the App View window, click "Enable."
3. In the App View window, click "Enable."
.. figure:: ../images/oc_updater_enable.png
@@ -65,17 +62,17 @@ The Updater app is enabled in your ownCloud instance by default when you install
Upgrading the ownCloud Server
=============================
The process for upgrading the ownCloud Server is fairly straightforward but requires planning and proper file and folder management.
The process for upgrading the ownCloud Server is fairly straightforward but requires planning and proper file and folder management.
To upgrade your ownCloud Server:
1. Ensure that you are running the latest point release of your current major ownCloud version (for example, point release 5.0.14a in the version 5.0 series). To update to the latest point release see updatingowncloud_.
1. Ensure that you are running the latest point release of your current major ownCloud version (for example, point release 5.0.14a in the version 5.0 series). To update to the latest point release see 'Updating ownCloud'_.
2. Deactivate all third party applications.
.. note:: Not all third party applications are supported on all ownCloud Server versions. Make sure to check version compatibility prior to upgrading your ownCloud server.
3. Back up your existing ownCloud Server database. You can find these procedures in backingupowncloud_.
3. Back up your existing ownCloud Server database. You can find these procedures in :doc:`backup`.
4. Download the latest ownCloud Server version to your working directory.
@@ -85,7 +82,7 @@ To upgrade your ownCloud Server:
For Windows operating systems:
See the installation instruction in installationserverwindows_.
See the installation instruction in :doc:`../installation/installation_windows`.
5. Stop your web server.
@@ -94,28 +91,28 @@ To upgrade your ownCloud Server:
To stop an Apache server, refer to the following table for specific commands to use in different Linux operating systems:
+------------------+----------------------------------------------+
| Operating System | Command (as root) |
+==================+==============================================+
| CentOS (Redhat) | ``apachectl stop`` |
+------------------+----------------------------------------------+
| Operating System | Command (as root) |
+==================+==============================================+
| CentOS (Redhat) | ``apachectl stop`` |
+------------------+----------------------------------------------+
| Debian | |
| or | ``/etc/init.d/apache2 stop`` |
| Ubuntu | |
+------------------+----------------------------------------------+
+------------------+----------------------------------------------+
| openSUSE | |
| or | ``/usr/sbin/rcapache2 stop`` |
| SUSE (SLE) | |
| SUSE (SLE) | |
+------------------+----------------------------------------------+
To stop the Windows IIS web server, you can use either the user interface (UI) or command line method as follows:
+----------------------+-------------------------------------------------------------------------+
| Method | Procedure |
+======================+=========================================================================+
| Method | Procedure |
+======================+=========================================================================+
| User Interface (UI) | 1. Open IIS Manager and navigate to the Web server node in the tree. |
| | |
| | 2. In the **Actions** pane, click **Stop**. |
+----------------------+-------------------------------------------------------------------------+
+----------------------+-------------------------------------------------------------------------+
| Command Line | 1. Open a command line window as administrator. |
| | |
| | 2. At the command prompt, type **net stop WAS** and press **ENTER**. |
@@ -143,11 +140,11 @@ To upgrade your ownCloud Server:
8. Copy and paste the ``/config/config.php`` file from the saved version of ownCloud to the ``/config`` directory of your new ownCloud version.
.. note:: You must perform this step **before* restarting your web server.
.. note:: You must perform this step **before** restarting your web server.
9. If you chose to keep your /data directory in your ``/owncloud`` directory, copy and paste it from the old version of ownCloud to the ``/owncloud`` directory of your new ownCloud version.
.. note:: We recommend storing your ``/data`` directory in a location other than your ``/owncloud`` directory. If you have your ``/data`` directory already stored in another location, you can skip this step. If you want to do so, now is a good time to change the location of your ``/data`` directory. See advancedoptions_ for added details about changing the default database or data directory.
.. note:: We recommend storing your ``/data`` directory in a location other than your ``/owncloud`` directory. If you have your ``/data`` directory already stored in another location, you can skip this step. If you want to do so, now is a good time to change the location of your ``/data`` directory. See "Advanved Options" chapter in :doc:`../installation/installation_wizard` for added details about changing the default database or data directory.
10. Restart your web server.
@@ -156,28 +153,28 @@ To upgrade your ownCloud Server:
To restart an Apache server, refer to the following table for specific commands to use in different Linux operating systems:
+------------------+----------------------------------------------+
| Operating System | Command (as root) |
+==================+==============================================+
| CentOS (Redhat) | ``apachectl start`` |
+------------------+----------------------------------------------+
| Operating System | Command (as root) |
+==================+==============================================+
| CentOS (Redhat) | ``apachectl start`` |
+------------------+----------------------------------------------+
| Debian | |
| or | ``/etc/init.d/apache2 start`` |
| Ubuntu | |
+------------------+----------------------------------------------+
+------------------+----------------------------------------------+
| openSUSE | |
| or | ``/usr/sbin/rcapache2 start`` |
| SUSE (SLE) | |
| SUSE (SLE) | |
+------------------+----------------------------------------------+
To start the Windows IIS web server, you can use either the user interface (UI) or command line method as follows:
+----------------------+-------------------------------------------------------------------------+
| Method | Procedure |
+======================+=========================================================================+
| Method | Procedure |
+======================+=========================================================================+
| User Interface (UI) | 1. Open IIS Manager and navigate to the Web server node in the tree. |
| | |
| | 2. In the **Actions** pane, click **Start**. |
+----------------------+-------------------------------------------------------------------------+
+----------------------+-------------------------------------------------------------------------+
| Command Line | 1. Open an elevated command line window. |
| | |
| | 2. At the command prompt, type **net start W3SVC** and press **ENTER**. |

28
user_manual/files/files.rst
View File

@@ -63,19 +63,19 @@ To mount the file system and access files using a command line:
1. Install the WebDAV support using the davfs package. For example, on Debian/Ubuntu, you can use::
sudo apt-get install davfs2
sudo apt-get install davfs2
2. Reconfigure davfs2 to allow access to normal users (select Yes when prompted)::
sudo dpkg-reconfigure davfs2
sudo dpkg-reconfigure davfs2
3. Specify any users that you want to have mount and share privileges in the davfs2 group::
sudo usermod -aG davfs2 <user>
sudo usermod -aG davfs2 <user>
4. Edit the :file:`/etc/fstab` file and add the following line for each user for whom you want to give mount privileges for the folder::
example.org/owncloud/remote.php/webdav /home/<username>/owncloud davfs user,rw,noauto 0 0
example.org/owncloud/remote.php/webdav /home/<username>/owncloud davfs user,rw,noauto 0 0
For each user for whom you wants to give mount privileges:
@@ -83,15 +83,15 @@ To mount the file system and access files using a command line:
2. Create the file ``secrets`` inside the ``.davfs2/`` folder and populate it with the following::
example.org/owncloud/remote.php/webdav <username> <password>
example.org/owncloud/remote.php/webdav <username> <password>
4. Ensure that the file is writable by only you by using the file manager or by issuing the following command::
``chmod 600 ~/.davfs2/secrets``
``chmod 600 ~/.davfs2/secrets``
5. Run the following command::
``mount ~/owncloud``
``mount ~/owncloud``
6. To automatically mount the folder on login, add the ``mount ~/owncloud`` command to the :file:`./.bashrc` file.
@@ -127,7 +127,7 @@ To access files through the MAC OSX Finder:
For example, the URL address used to connect to the ownCloud installation from the MAC OSX Finder is::
http://example.org/owncloud/remote.php/webdav
http://example.org/owncloud/remote.php/webdav
.. image:: ../images/osx_webdav2.png
@@ -171,7 +171,7 @@ The following example shows how to map a drive using the command line. To map t
1. Open a command prompt in Windows.
2. Enter the following line in the command prompt to map to the computer Z drive::
net use Z: https://<drive_path>/remote.php/webdav /user:youruser yourpassword
net use Z: https://<drive_path>/remote.php/webdav /user:youruser yourpassword
where <drive_path> is **example.org/owncloud**
@@ -204,7 +204,7 @@ To map a drive using the Microsoft Windows Explorer:
For example::
https://example.org/owncloud/remote.php/webdav
https://example.org/owncloud/remote.php/webdav
.. note:: For SSL protected servers, check **Reconnect at logon** to ensure
that the mapping is persistent upon subsequent reboots. If you want to connect
@@ -291,10 +291,10 @@ To connect to your ownCloud server with any **ownCloud** mobile apps, use the ba
.. note:: There is no need to add remote.php/webdav as you do for other WebDAV clients.
Mobiel apps currently exist for both `Android`_ and `webOS`_. Feel free to `contribute, if you can`_!
Mobile apps currently exist for both `Android`_ and `webOS`_. Feel free to `contribute, if you can`_!
In addition to the mobile apps provided by ownCloud, you can use other apps to connect to ownCloud from your mobile device using WebDAV. `WebDAV Navigator`_ is a
good (proprietary) app for `Android`_ devices, `iPhones`_, and `BlackBerry`_ devices.
good (proprietary) app for `Android devices`_, `iPhones`_, and `BlackBerry devices`_.
The URL for these is::
@@ -308,6 +308,6 @@ The URL for these is::
.. _webOS: http://github.com/owncloud/webos
.. _contribute, if you can: /contribute/
.. _WebDAV Navigator: http://seanashton.net/webdav/
.. _Android: https://play.google.com/store/apps/details?id=com.schimera.webdavnavlite
.. _Android devices: https://play.google.com/store/apps/details?id=com.schimera.webdavnavlite
.. _iPhones: https://itunes.apple.com/app/webdav-navigator/id382551345
.. _BlackBerry: http://appworld.blackberry.com/webstore/content/46816
.. _BlackBerry devices: http://appworld.blackberry.com/webstore/content/46816

7
user_manual/files/quota.rst
View File

@@ -18,12 +18,13 @@ access your personal settings:
1. Click the Personal Settings dropdown menu to the right of the Search field
in the ownCloud Main User Interface.
.. figure:: ../images/oc_personal_settings_dropdown.png
Personal Settings menu
.. figure:: ../images/oc_personal_settings_dropdown.png
Personal Settings menu
2. Select "Personal" from the menu. The Personal Settings window opens.
.. figure:: ../images/oc_personal_settings_window.png
.. figure:: ../images/oc_personal_settings_window.png
The available space of a given user is calculated using the following formula::

1
user_manual/webinterface.rst
View File

@@ -46,6 +46,7 @@ Once you have accessed the ownCloud Server main web interface you can add files,
.. figure:: images/oc_main_web_labelled.png
:scale: 60%
**Navigating the main user interface**
The ownCloud Maine User Interface contains the following fields and functions: