Skip to content

Commit

Permalink
feat(docs): update readme to include instructions on using the docker…
Browse files Browse the repository at this point in the history
… image
  • Loading branch information
flawiddsouza committed Apr 7, 2023
1 parent bf00d63 commit 7237a29
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ jobs:
run: |
docker build -t flawiddsouza/restfox:${{ env.VERSION }} .
- name: Login to Docker Hub
uses: docker/login-action@v1
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Restfox

[**Website**](https://restfox.dev) **|** [**Install**](#installation) **|** [**Releases/Downloads**](https://github.com/flawiddsouza/Restfox/releases) **|** [**Screenshots**](#screenshots) **|** [**Compiling**](#compiling) **|** [**Compiling Web Standalone**](#using-web-standalone)
[**Website**](https://restfox.dev) **|** [**Install**](#installation) **|** [**Releases/Downloads**](https://github.com/flawiddsouza/Restfox/releases) **|** [**Screenshots**](#screenshots) **|** [**Compiling**](#compiling) **|** [**Compiling Web Standalone**](#using-web-standalone)

Offline-first web HTTP client

Expand All @@ -22,6 +22,11 @@ There are precompiled binaries in the [releases](https://github.com/flawiddsouza
### Windows
There are precompiled binaries in the [releases](https://github.com/flawiddsouza/Restfox/releases) page.

### [Docker](https://hub.docker.com/r/flawiddsouza/restfox)
```
docker run --name Restfox -d -p 4004:4004 flawiddsouza/restfox:0.0.8
```

## Screenshots

<img src="screenshots/1.png?raw=true">
Expand Down Expand Up @@ -147,15 +152,17 @@ By default npm start will run Restfox at port 4004. You can override the port by

## Built and used by Docker

First refer to [**Compiling Web Standalone**](#using-web-standalone) to build successfully locally and use it normally.
Then in the project root directory (directory with Dockerfile), execute:
First refer to [**Compiling Web Standalone**](#using-web-standalone) to build successfully locally and use it normally.
Then in the project root directory (directory with Dockerfile), execute:
```
docker build -t restfox:xx .
```
> Note: xx is the version number
After the build is complete, use the following command to start the service:
After the build is complete, use the following command to start the service:
```
docker run -d -p:4004:4004 restfox:xx
```
Visit after successful startup: localhost:4004
Visit after successful startup: localhost:4004

Alternatively, you can also use the pre-built Docker image available on [Docker Hub](https://hub.docker.com/r/flawiddsouza/restfox). See: [**Docker**](#docker).

0 comments on commit 7237a29

Please sign in to comment.