Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/EricLarG4/OligoR
Browse files Browse the repository at this point in the history
  • Loading branch information
EricLarG4 committed Mar 2, 2023
2 parents 91d3eb8 + 0d908c0 commit efd49a7
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 3 deletions.
30 changes: 29 additions & 1 deletion .github/workflows/Create_publish_Docker_image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ name: Create and publish a Docker image
on:
push:
branches: [ "master" ]
workflow_dispatch:
inputs:
logLevel:
description: 'Log level'
required: true
default: 'warning'
type: choice
options:
- info
- warning
- debug
tags:
description: 'Test scenario tags'
required: false
type: boolean
environment:
description: 'Environment to run tests against'
type: environment
required: true

env:
REGISTRY: ghcr.io
Expand All @@ -35,11 +54,20 @@ jobs:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Log in to Docker Hub
uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}

- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
images: |
ericlarg4/oligor
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
- name: Build and push Docker image
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
Expand Down
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ Although developed with oligonucleotides in mind, OligoR can be used for other t

OligoR is an entirely open-source application, that can be run from the source code in R, or more simply from a Docker container.

# Installation and updating
# Online access

OligoR may be accessed online, provided the server is running, at [oligor.seis.me](http://oligor.seis.me)

# Installation and updating for local use

## From R source code

Expand All @@ -24,9 +28,15 @@ To update, either download the latest version of OligoR, or if you have cloned t

This method requires the installation of [Docker Desktop](https://docs.docker.com/get-docker/).

From a terminal, execute the following command to obtain the OligoR image.
From a terminal, execute either of the following command to obtain the OligoR image.

From GitHub:

docker pull ghcr.io/ericlarg4/oligor:master

From DockerHub:

docker pull ericlarg4/oligor:master

To update, simply use the above command again, or click on pull in the Docker desktop software (click on the three dot menu on the image line, then click on pull). This image is automatically re-built when the source code is changed.

Expand Down

0 comments on commit efd49a7

Please sign in to comment.