Skip to content

Commit acca26f

Browse files
committed
chore: Update README.
1 parent 2b7e8a4 commit acca26f

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ jobs:
101101
- run: rm -r -f .netrc
102102

103103
docker-build-push:
104+
name: Deploy to Docker Hub
104105
runs-on: ubuntu-latest
105106
steps:
106107
- name: Login to Docker Hub

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ A basic web app client in the **/client** directory will show basic API usage an
1313
- [Installation and Usage Using Docker](#installation-and-usage-using-docker)
1414
- [Docker for Localhost Development](#docker-for-localhost-development)
1515
- [Docker for Production Deployment](#docker-for-production-deployment)
16+
- [Pre-built Server Docker Image](#pre-built-server-docker-image)
1617
- [References](#references)
1718

1819
## Requirements
@@ -178,6 +179,32 @@ The following docker-compose commands build small client and server images targe
178179
7. Stop and remove containers, networks, images and volumes:
179180
`docker-compose -f docker-compose-prod.yml down`
180181

182+
## Pre-built Server Docker Image
183+
184+
**firebase-users-admin**'s `server` component is available as a stand-alone docker image on Docker Hub.
185+
186+
1. Pull the (production) **/server** docker image from Docker Hub.
187+
`docker pull ciatphdev/firebase-users-admin-server:v1.1.0`
188+
2. Create a `.env` file.
189+
- Read [**Installation - server #3**](#server) for more information.
190+
- Replace the variables accordingly in the `.env` file.
191+
```
192+
ALLOWED_ORIGINS=http://localhost,http://localhost:3000,http://mywebsite.com,http://yourwebsite.com
193+
FIREBASE_SERVICE_ACC=YOUR-FIREBASE-PROJ-SERVICE-ACCOUNT-JSON-CREDENTIALS-ONE-LINER-NO-SPACES
194+
FIREBASE_PRIVATE_KEY=PRIVATE-KEY-FROM-FIREBASE-SERVICE-ACCOUNT-JSON-WITH-DOUBLE-QUOTES
195+
196+
```
197+
3. Run the image.
198+
```
199+
docker run -it --rm \
200+
--env-file .env
201+
-p 3001:3001 \
202+
ciatphdev/firebase-users-admin-server:v1.1.0
203+
```
204+
4. Launch the server API documentation on
205+
`http://localhost:3001/docs`
206+
207+
181208
## References
182209
183210
[[1]](https://docs.docker.com/compose/reference/) - docker compose commands

0 commit comments

Comments
 (0)