docs(readme): add information about self hosting
Signed-off-by: SphericalKat <amolele@gmail.com>
This commit is contained in:
parent
1d3a492814
commit
d19fe38aee
34
README.md
34
README.md
@ -1,4 +1,4 @@
|
|||||||
# Ketbin
|
# Katbin
|
||||||
|
|
||||||
To start your Phoenix server:
|
To start your Phoenix server:
|
||||||
|
|
||||||
@ -11,7 +11,37 @@ To start your Phoenix server:
|
|||||||
|
|
||||||
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
||||||
|
|
||||||
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
|
# Self hosting
|
||||||
|
|
||||||
|
We recommend using our [official docker image](https://hub.docker.com/r/atechnohazard/katbin-elixir). If you wish to build your own docker image, the provided Dockerfile should work out of the box. If you run into any problems, please open an issue.
|
||||||
|
|
||||||
|
## Populating the environment
|
||||||
|
Copy the provided `sample.env` file to `.env`
|
||||||
|
```sh
|
||||||
|
cp sample.env .env
|
||||||
|
```
|
||||||
|
|
||||||
|
Fill in this new file with the required environment variables.
|
||||||
|
|
||||||
|
## Using the official docker image
|
||||||
|
```sh
|
||||||
|
docker un --env-file .env atechnohazard/katbin-elixir
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building the docker image
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/SphericalKat/katbin
|
||||||
|
cd katbin
|
||||||
|
docker build -t <username>/katbin .
|
||||||
|
```
|
||||||
|
|
||||||
|
## Running the built docker image
|
||||||
|
```sh
|
||||||
|
docker run --env-file .env <username>/katbin
|
||||||
|
```
|
||||||
|
|
||||||
|
For other methods of self hosting, please check the [official Phoenix deployment guides](https://hexdocs.pm/phoenix/deployment.html).
|
||||||
|
|
||||||
|
|
||||||
## Learn more
|
## Learn more
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user