Skip to content

docs: update README and added DockerHub badge #1264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
juzhiyuan merged 8 commits into from
Jan 12, 2021
Merged

docs: update README and added DockerHub badge #1264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8fb2746
docs: update README and added DockerHub badge
juzhiyuan Jan 11, 2021
2f443f7
Update deploy-with-docker.md
juzhiyuan Jan 11, 2021
883dc7b
Merge branch 'master' into juzhiyuan-patch-1
juzhiyuan Jan 11, 2021
2a557e8
Merge branch 'master' into juzhiyuan-patch-1
juzhiyuan Jan 11, 2021
9f08a30
Merge branch 'master' into juzhiyuan-patch-1
juzhiyuan Jan 12, 2021
b301e6b
Update deploy-with-docker.md
juzhiyuan Jan 12, 2021
db8b8d9
Merge branch 'master' into juzhiyuan-patch-1
juzhiyuan Jan 12, 2021
b0b7ca5
Merge branch 'master' into juzhiyuan-patch-1
juzhiyuan Jan 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/apache/apisix-dashboard/blob/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/apache/apisix-dashboard)](https://goreportcard.com/report/github.com/apache/apisix-dashboard)
[![DockerHub](https://img.shields.io/docker/pulls/apache/apisix-dashboard.svg)](https://hub.docker.com/r/apache/apisix-dashboard)

<p align="center">
<a href="https://apisix.apache.org/">Website</a> •
Expand All @@ -30,7 +31,7 @@

- The master version should be used with Apache APISIX master version.

- The latest released version is 2.2 and should be used with Apache APISIX 2.1. It is not recommended to use with other Apache APISIX versions.
- The latest released version is [2.3](https://apisix.apache.org/downloads/) and should be used with [Apache APISIX 2.2](https://apisix.apache.org/downloads/). It is not recommended to use with other Apache APISIX versions.


## What's Apache APISIX Dashboard
Expand Down
4 changes: 3 additions & 1 deletion docs/deploy-with-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@

# Building and Launching with Docker

To build a Dashboard with Docker, you simply download the `Dockerfile` file from the **root directory** to your device (no need to download all source codes) then follow this guide.
**NOTE:** We support Docker Image, please visit [DockerHub](https://hub.docker.com/r/apache/apisix-dashboard) for more information. The following steps are for building Docker Image manually.

To build the Dashboard with Docker, you simply download the `Dockerfile` file from the **root directory** to your device (no need to download all source codes) then follow this guide.

@imjoey imjoey Jan 11, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about provide a download link for this Dockerfile?

@juzhiyuan juzhiyuan Jan 11, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 We may use this repo[1] to manage all products' Dockerfile in M2.4, let me create an issue to track this.

[1] https://github.com/apache/apisix-docker

@juzhiyuan juzhiyuan Jan 11, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1265


The `manager-api` and `web` will be included in this build guide product.

Expand Down