Skip to content

Commit

Permalink
Update install applications
Browse files Browse the repository at this point in the history
  • Loading branch information
lukfor committed Oct 18, 2024
1 parent 4406b8d commit a1c8df5
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 26 deletions.
Binary file modified docs/images/screenshots/apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/screenshots/install--app-from-repo.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/screenshots/install-apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 13 additions & 17 deletions docs/server/install-apps.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Install Applications

An online repository of all available applications can be found [here](http://apps.cloudgene.io).

## Web-Application

Open the **Admin Panel** and click on the **Applications** tab to see all installed applications.

By clicking on the Install Apps button, you can install an application either by entering a URL (HTTP or a local path) or by selecting from GitHub and entering a repository, optionally specifying a version.

<div class="screenshot">
<img src="../../images/screenshots/install-apps.png">
</div>

After clicking on **Install App** > **from apps.clougene.io** a list of all available applications registed in our [repository](http://apps.cloudgene.io) appears. Choose an application you want to use an click on **Install** to start the installation process.

<div class="screenshot">
<img src="../../images/screenshots/install--app-from-repo.png">
<img src="../../images/screenshots/install-app-from-github.png">
</div>


Depending on your Internet connection and computer resources it could take several minutes. If the installation was successful, you should see your application in the the **Applications** tab:

<div class="screenshot">
Expand All @@ -33,25 +33,26 @@ You can install also applications by using the [`install`](/cli/cloudgene-instal
```sh
cloudgene install <location>
```
`Location` could be a zip file or a yaml file accessible via http or which is located on the local filesystem. For example, the following command installs an application that is hosted on a web server:

`location` could be a zip file or a yaml file accessible via http or which is located on the local filesystem. For example, the following command installs an application that is hosted on a web server:

```sh
cloudgene install https://github.com/lukfor/hello-cloudgene/archive/master.zip
cloudgene install https://github.com/lukfor/cg-fetchngs/archive/master.zip
```

You can also install applications directly from GitHub. For example, the latest version of the **hello-cloudgene** application can be installed by using the following command:
You can also install applications directly from GitHub. For example, the latest version of the **cg-fetchngs** application can be installed by using the following command:

```sh
cloudgene install lukfor/hello-cloudgene
cloudgene install lukfor/cg-fetchngs
```

To install a specific version of a application you can specify a git tag:

```sh
cloudgene install lukfor/hello-cloudgene@1.2.0
cloudgene install lukfor/cg-fetchngs@1.0.0
```

The ids are created automatically for all applications (e.g. `hello-cloudgene@1.2.0`).
The ids are created automatically for all applications (e.g. `cg-fetchngs@1.0.0`).


### List installed applications
Expand All @@ -74,14 +75,9 @@ An installed application can be removed with the `remove` command:
cloudgene remove <id>
```

For example to remove **hello-cloudgne 1.2.0** ,
For example to remove **cg-fetchngs 1.0.0** ,

```sh
cloudgene remove hello-cloudgene@1.2.0
cloudgene remove cg-fetchngs@1.0.0
```

## What's next?

- [Connect Cloudgene to a Hadoop Cluster](/daemon/hadoop) to enable applications to use MapReduce, Spark, PIG or other Hadoop based technologies
- Install R and RMarkdown to enable applications to create reports
- Install Docker to enable applications to take advantage of Docker images
17 changes: 8 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,13 @@ nav:
- Installation: installation.md
- Documentation:
- Getting Started: server/getting-started.md
- Server Management:
- Install Applications: server/install-apps.md
- Manage Permissions: server/permissions.md
- Manage Jobs: server/jobs.md
- Configuration: server/configuration.md
- Configure Nextflow: server/configure-nextflow.md
- Customization: server/customization.md
- Administration: server/administration.md
- Install Applications: server/install-apps.md
- Manage Permissions: server/permissions.md
- Manage Jobs: server/jobs.md
- Configuration: server/configuration.md
- Configure Nextflow: server/configure-nextflow.md
- Customization: server/customization.md
- Administration: server/administration.md
- Develop Applications:
- Getting Started: developers/introduction.md
- Inputs: developers/inputs.md
Expand Down Expand Up @@ -77,9 +76,9 @@ nav:
- List Jobs: api/list-jobs.md
- Job Details: api/job-details.md
- Tutorials:
- Using AppLinks to link to other applications: tutorials/application-links.md
- Getting Started with Cloudgene and Nextflow Pipeline Integration: tutorials/nextflow-integration.md
- Getting Started with Reporting: tutorials/nextflow-reporting.md
- Using AppLinks to link to other applications: tutorials/application-links.md
- About: about.md

markdown_extensions:
Expand Down

0 comments on commit a1c8df5

Please sign in to comment.