mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-02 17:59:36 +07:00
2647cd93c7
This moves lots of pages around. The high-level changes are * Better main sections, so it's more *general*, *into*, *basics* and *details* * Move more general topics to a *Basic* section, which are not app-specific * Remove app docs to the stuff that is likely used, anything else goes into "Digging deeper" * Move general guides into a prologue * Try to *compress*/combine some pages with similar content * Try to have better consistencs on level ob abstraction across pages * Split app development and maintenance pages into two sections * Integrate bugtracker info into prologue * Integrate Android pages into client APIs section Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
125 lines
3.8 KiB
ReStructuredText
125 lines
3.8 KiB
ReStructuredText
.. _devenv:
|
|
|
|
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
|
|
|
=======================
|
|
Development environment
|
|
=======================
|
|
|
|
Please follow the steps on this page to set up your development environment.
|
|
|
|
Set up Web server and database
|
|
------------------------------
|
|
|
|
First `set up your Web server and database <https://docs.nextcloud.org/server/stable/admin_manual/installation/index.html>`_ (**Section**: Manual Installation - Prerequisites).
|
|
|
|
.. TODO ON RELEASE: Update version number above on release
|
|
|
|
Get the source
|
|
--------------
|
|
|
|
There are two ways to obtain Nextcloud sources:
|
|
|
|
* Using the `stable version <https://docs.nextcloud.org/server/stable/admin_manual/#installation>`_
|
|
* Using the development version from `GitHub`_ which will be explained below.
|
|
|
|
.. TODO ON RELEASE: Update version number above on release
|
|
|
|
To check out the source from `GitHub`_ you will need to install Git (see `Setting up Git <https://help.github.com/articles/set-up-git>`_ from the GitHub help)
|
|
|
|
Gather information about server setup
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
To get started the basic Git repositories need to be cloned into the Web server's directory. Depending on the distribution this will either be
|
|
|
|
* **/var/www**
|
|
* **/var/www/html**
|
|
* **/srv/http**
|
|
|
|
|
|
Then identify the user and group the Web server is running as and the Apache user and group for the **chown** command will either be
|
|
|
|
* **http**
|
|
* **www-data**
|
|
* **apache**
|
|
* **wwwrun**
|
|
|
|
Check out the code
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
The following commands are using **/var/www** as the Web server's directory and **www-data** as user name and group.
|
|
|
|
After the development tool installation make the directory writable so you install the code as your regular user, and don't need root privileges::
|
|
|
|
sudo chmod o+rw /var/www
|
|
|
|
Then install Nextcloud at the root of your site from Git::
|
|
|
|
git clone https://github.com/nextcloud/server.git /var/www/
|
|
cd /var/www
|
|
git submodule update --init
|
|
|
|
If you like to install Nextcloud at a sub-folder, replace `/var/www` with `/var/www/<folder>`.
|
|
|
|
Create the data and the config folders::
|
|
|
|
cd /var/www
|
|
mkdir data
|
|
mkdir config
|
|
|
|
Adjust rights::
|
|
|
|
cd /var/www
|
|
sudo chown -R www-data:www-data config data apps
|
|
sudo chmod o-rw /var/www
|
|
|
|
Finally restart the Web server (this might vary depending on your distribution)::
|
|
|
|
sudo systemctl restart httpd.service
|
|
|
|
or::
|
|
|
|
sudo systemctl restart apache2.service
|
|
|
|
or::
|
|
|
|
sudo /etc/init.d/apache2 restart
|
|
|
|
Now access the installation at http://localhost/ (or the corresponding URL) in your web browser to set up your instance.
|
|
|
|
Enabling debug mode
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. _debugmode:
|
|
|
|
.. note:: Do not enable this for production! This can create security problems and is only meant for debugging and development!
|
|
|
|
To disable JavaScript and CSS caching debugging has to be enabled by setting ``debug`` to ``true`` in :file:`config/config.php`::
|
|
|
|
<?php
|
|
$CONFIG = array (
|
|
'debug' => true,
|
|
... configuration goes here ...
|
|
);
|
|
|
|
Keep the code up-to-date
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
If you have more than one repository cloned, it can be time consuming to do the same the action to all repositories one by one. To solve this, you can use the following command template::
|
|
|
|
find . -maxdepth <DEPTH> -type d -name .git -exec sh -c 'cd "{}"/../ && pwd && <GIT COMMAND>' \;
|
|
|
|
then, e.g. to pull all changes in all repositories, you only need this::
|
|
|
|
find . -maxdepth 3 -type d -name .git -exec sh -c 'cd "{}"/../ && pwd && git pull --rebase' \;
|
|
|
|
or to prune all merged branches, you would execute this::
|
|
|
|
find . -maxdepth 3 -type d -name .git -exec sh -c 'cd "{}"/../ && pwd && git remote prune origin' \;
|
|
|
|
It is even easier if you create alias from these commands in case you want to avoid retyping those each time you need them.
|
|
|
|
|
|
.. _GitHub: https://github.com/nextcloud
|
|
.. _GitHub Help Page: https://help.github.com/
|