redoc

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #go #machine-learning #rust #deep-learning #macos #java #kubernetes #pytorch #ios #openai

(★ 83)

Redoc with multiple urls - https://hub.docker.com/r/volbrene/redoc

File Explorer

Download Latest Version (.zip)

- - config.js
  - favicon.ico
  - index.html
  - logo192.png
  - logo512.png
  - manifest.json
  - robots.txt
- - index.css
  - index.js
  - logo.png
  - serviceWorker.js
- .gitignore
- package-lock.json
- package.json
- README.md
- default.conf
- run.sh
.gitignore
demo.gif
docker-compose.yml
Dockerfile
LICENSE.md
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ReDoc with multi API support
[![Docker Pulls](https://img.shields.io/docker/pulls/volbrene/redoc.svg)](https://hub.docker.com/r/volbrene/redoc/) [![Docker Stars](https://img.shields.io/docker/stars/volbrene/redoc.svg)](https://hub.docker.com/r/volbrene/redoc/) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/volbrene/redoc/blob/master/LICENSE)

This Docker image supports ReDoc >2.0 with multi select APIs.

Dockerhub: [Link to Dockerhub](https://hub.docker.com/r/volbrene/redoc)

# Demo

![](https://raw.githubusercontent.com/volbrene/redoc/master/demo.gif)

# How to use with external urls?

```console
docker run -d \
    -p 8080:80 \
    -e URLS="[{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop'},{url: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', name: 'Instagram'}]" \
     volbrene/redoc
```

That's it.

# How to use with local files?

```console
docker run -d \
    -p 8080:80 \
    -v $(pwd)/swagger-files:/var/www/html/static/swagger-files \
    -e URLS="[{url: '/static/swagger-files/petstore.json', name: 'Petshop'},{url: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', name: 'Instagram'}]" \
     volbrene/redoc
```

That's it.

## Environment variables

This image uses environment variables for configuration.

| Available variables | Default value                                                                                                                                   | Description                                                                                      |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `URLS`              | [{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop'},{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop 2'}] | List of api swagger docs                                                                         |
| `THEME_COLOR`       | #32329f                                                                                                                                         | Primary Color                                                                                    |
| `PAGE_TITLE`        | Redoc                                                                                                                                           | Page Title of docs                                                                               |
| `BASE_NAME`         | '' -> (no prefix)                                                                                                                               | `basename` prop for the top-level [BrowserRouter](https://reactrouter.com/web/api/BrowserRouter) |

## You prefer Swagger UI?

No Problem. Hier is the project for all, who loves swagger ui:

[Link to Docker Hub](https://hub.docker.com/r/volbrene/swagger-ui)

[Link to GitHub](https://github.com/volbrene/swagger-ui)

redoc

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

redoc

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README