Skip to content

Commit d3f2bae

Browse files
committed
update readme
1 parent 1f700c9 commit d3f2bae

File tree

1 file changed

+88
-2
lines changed

1 file changed

+88
-2
lines changed

README.md

+88-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,94 @@
11
# self-hosted-unpkg
22

3-
## How to run
3+
## Run locally
44
Create .env file. (see sample.env) and run:
55

66
```bash
7-
docker run -it --rm -p 443:443 -p 80:80 -v /local/path/to/cache:/usr/src/app/cache -v /local/path/to/ssl/acme:/usr/src/app/acme --env-file ./.env --name self-hosted-unpkg interactivetraining/self-hosted-unpkg
7+
docker run -it --rm -p 443:443 -p 80:80 -v /local/path/to/cache:/usr/src/app/cache --env-file ./.env --name self-hosted-unpkg interactivetraining/self-hosted-unpkg
8+
```
9+
10+
## Kubernetes Deployment
11+
12+
### Create a secret from your env file
13+
```bash
14+
kubectl create secret generic __MY_SECRET_NAME__ --from-env-file ./path/to/.env
15+
```
16+
17+
### Add each variable to your deployment
18+
```yaml
19+
apiVersion: extensions/v1beta1
20+
kind: Deployment
21+
spec:
22+
template:
23+
spec:
24+
containers:
25+
- env:
26+
- name: DOMAIN
27+
valueFrom:
28+
secretKeyRef:
29+
key: DOMAIN
30+
name: __MY_SECRET_NAME__
31+
- name: NPM_REGISTRY
32+
valueFrom:
33+
secretKeyRef:
34+
key: NPM_REGISTRY
35+
name: __MY_SECRET_NAME__
36+
- name: NPM_TOKEN
37+
valueFrom:
38+
secretKeyRef:
39+
key: NPM_TOKEN
40+
name: __MY_SECRET_NAME__
41+
- name: CLOUDFLARE_EMAIL
42+
valueFrom:
43+
secretKeyRef:
44+
key: CLOUDFLARE_EMAIL
45+
name: __MY_SECRET_NAME__
46+
- name: CLOUDFLARE_API_KEY
47+
valueFrom:
48+
secretKeyRef:
49+
key: CLOUDFLARE_API_KEY
50+
name: __MY_SECRET_NAME__
51+
- name: LETS_ENCRYPT_EMAIL
52+
valueFrom:
53+
secretKeyRef:
54+
key: LETS_ENCRYPT_EMAIL
55+
name: __MY_SECRET_NAME__
56+
- name: LETS_ENCRYPT_AGREE_TO_TOS
57+
valueFrom:
58+
secretKeyRef:
59+
key: LETS_ENCRYPT_AGREE_TO_TOS
60+
name: __MY_SECRET_NAME__
61+
- name: GOOGLE_CLOUD_BUCKET_NAME
62+
valueFrom:
63+
secretKeyRef:
64+
key: GOOGLE_CLOUD_BUCKET_NAME
65+
name: __MY_SECRET_NAME__
66+
- name: GOOGLE_CLOUD_PROJECT_ID
67+
valueFrom:
68+
secretKeyRef:
69+
key: GOOGLE_CLOUD_PROJECT_ID
70+
name: __MY_SECRET_NAME__
71+
- name: GOOGLE_CLOUD_CERT_DB_FILE
72+
valueFrom:
73+
secretKeyRef:
74+
key: GOOGLE_CLOUD_CERT_DB_FILE
75+
name: __MY_SECRET_NAME__
76+
- name: GOOGLE_CLOUD_CLIENT_EMAIL
77+
valueFrom:
78+
secretKeyRef:
79+
key: GOOGLE_CLOUD_CLIENT_EMAIL
80+
name: __MY_SECRET_NAME__
81+
- name: GOOGLE_CLOUD_PRIVATE_KEY
82+
valueFrom:
83+
secretKeyRef:
84+
key: GOOGLE_CLOUD_PRIVATE_KEY
85+
name: __MY_SECRET_NAME__
86+
- name: ENABLE_SSL
87+
valueFrom:
88+
secretKeyRef:
89+
key: ENABLE_SSL
90+
name: __MY_SECRET_NAME__
91+
image: interactivetraining/self-hosted-unpkg:latest
92+
imagePullPolicy: Always
93+
name: self-hosted-unpkg
894
```

0 commit comments

Comments
 (0)