Merge pull request #35 from DeathGabox/patch-1
Update Readme.md and docker-compose.yaml
This commit is contained in:
18
README.md
18
README.md
@@ -14,7 +14,17 @@ A self hostable service for sending ebooks to a Kobo or Kindle ereader through t
|
||||
6. Start this service by running: `$ npm start` and access it on HTTP port 3001
|
||||
|
||||
### Containerized
|
||||
|
||||
1. Have Docker installed
|
||||
2. Run `$ docker compose up`
|
||||
3. Access the service on HTTP port 3001
|
||||
1. You need [Docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) installed
|
||||
2. Clone this repo (you need Dockerfile, docker-compose.yaml and package.json in the same directory)
|
||||
```
|
||||
git clone https://github.com/daniel-j/send2ereader.git
|
||||
```
|
||||
3. Build the image
|
||||
```
|
||||
docker compose build
|
||||
```
|
||||
4. run container (-d to keep running in the background)
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
5. Access the service on HTTP, default port 3001 (http://localhost:3001)
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
version: "3"
|
||||
services:
|
||||
send2ereader:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ./Dockerfile
|
||||
container_name: send2ereader
|
||||
# Restart means, Automatic re-start the container after a shutdown unless manual stop container
|
||||
restart: unless-stopped
|
||||
# ports means, Bind external and internal docker ports, only change the external port, not the internal port
|
||||
# Arquitecture: <External Port>:<Internal Port>
|
||||
ports:
|
||||
- 3001:3001
|
||||
|
||||
Reference in New Issue
Block a user