Skip to content

Commit

Permalink
fix: update installation steps
Browse files Browse the repository at this point in the history
Signed-off-by: Edward Ly <contact@edward.ly>
  • Loading branch information
edward-ly committed Oct 22, 2024
1 parent 39b3e57 commit 5ecd3b3
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 67 deletions.
63 changes: 6 additions & 57 deletions admin_manual/exapps_management/Installation.rst
Original file line number Diff line number Diff line change
@@ -1,65 +1,14 @@
Installation
============

There are two ways to install the AppAPI: from the `AppStore <https://apps.nextcloud.com/apps/app_api>`_ or from the source code.
As of Nextcloud 30, AppAPI is automatically installed by default.
If AppAPI is not installed, you can still install it from the `App Store <https://apps.nextcloud.com/apps/app_api>`_.
Simply navigate to the Apps management page in your Nextcloud and search for AppAPI from the Tools category.

.. note::
Setup deploy daemon
*******************

AppAPI 3.0.0 is the last version supported Nextcloud 27.


Installation from the AppStore
------------------------------

Simply navigate to the Apps management page in your Nextcloud and setup the AppAPI from the Tools category.

Installation from the source code
---------------------------------

To install the AppAPI from the source code, follow these steps:

1. Clone the AppAPI repository into your apps directory
*******************************************************

Clone the latest main branch:

.. code-block:: bash
git clone https://github.com/cloud-py-api/app_api.git
or clone a specific version by specifying the version tag:

.. code-block:: bash
git clone https://github.com/cloud-py-api/app_api.git --branch <version-tag>
where ``<version-tag>`` is the version you want to install.


2. Build frontend assets in production mode
********************************************

.. code-block:: bash
npm ci && npm run build
3. Enable the AppAPI
********************

.. code-block:: bash
./occ app:enable --force app_api
4. Setup Deploy daemon
**********************

Upon the successful installation of the AppAPI, a one-time configuration is essential.
Details on this configuration can be found in the subsequent section: :ref:`create-deploy-daemon`.

4.1 Deploy daemon configuration
*******************************

Deploy daemon configuration steps:
After successful installation, a one-time configuration of the deploy daemon is required:

1. Go to the AppAPI admin settings.
2. Click on the "Register Daemon" button.
Expand Down
30 changes: 20 additions & 10 deletions developer_manual/exapp_development/DevSetup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,34 @@ We highly recommend using `Julius Haertl docker setup <https://github.com/julius

Suggested IDE: **PhpStorm**, though you can certainly use any IDE of your preference such as **VS Code** or **Vim**.

Get last version from GitHub
""""""""""""""""""""""""""""
Installation from the source code
""""""""""""""""""""""""""""""""""

Assuming you're in the ``apps`` folder of Nextcloud with command :command:`git`::
Clone the latest main branch:

git clone https://github.com/cloud-py-api/app_api.git
.. code-block:: bash
Change to the ``app_api`` directory with :command:`shell`::
git clone https://github.com/cloud-py-api/app_api.git && cd app_api
cd app_api
or clone a specific version by specifying the version tag:

Then, build frontend assets in development mode with :command:`shell`::
.. code-block:: bash
npm ci && npm run dev
git clone https://github.com/cloud-py-api/app_api.git --branch <version-tag> && cd app_api
After this, you can enable it from the directory where the ``occ`` command resides, with :command:`shell`::
where ``<version-tag>`` is the version you want to install.

./occ app:enable --force app_api
Then, build frontend assets in development mode:

.. code-block:: bash
npm ci && npm run build
Enable AppAPI from the directory where the ``occ`` command resides:

.. code-block:: bash
./occ app:enable --force app_api
In Place of a Conclusion
""""""""""""""""""""""""
Expand Down

0 comments on commit 5ecd3b3

Please sign in to comment.