Skip to content

Commit a18fcd6

Browse files
committed
Update README.
1 parent f3fc2db commit a18fcd6

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,18 @@ To manually install this project, simply run the following:
2121

2222
$ git clone https://github.com/PyFunceble/web-worker.git pyfunceble-web-worker
2323
$ cd pyfunceble-web-worker
24-
$ pip3 install --user PyFunceble-dev uvicorn
24+
$ pip3 install --user PyFunceble-dev uvicorn[standard]
2525
$ pip3 install --user .
2626

27+
GitHub Packages
28+
"""""""""""""""
29+
30+
To pull the docker image, simply run the following:
31+
32+
::
33+
34+
$ docker pull ghcr.io/pyfunceble/web-worker/web-worker:latest
35+
2736
Docker (self-build)
2837
"""""""""""""""""""
2938

@@ -60,7 +69,17 @@ To start the project, simply run or adapt the following:
6069
::
6170

6271
$ cd pyfunceble-web-worker
63-
$ uvicorn pyfunceble_webworker.main:app
72+
$ uvicorn pyfunceble_webworker.main:app --host 0.0.0.0 --port 80
73+
74+
GitHub Packages
75+
"""""""""""""""
76+
77+
To start the project after pulling it from the GitHub Packages, simply run or
78+
adapt the following:
79+
80+
::
81+
82+
$ docker run -v pyfunceble-worker-data:/data -d --name [my-awesome-name] -p [my-port]:80 ghcr.io/pyfunceble/web-worker/web-worker:latest
6483

6584
Docker (self-built)
6685
"""""""""""""""""""

0 commit comments

Comments
 (0)