You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
76 lines
3.0 KiB
76 lines
3.0 KiB
# StackEdit Docker server
|
|
|
|
*StackEdit v5.14.5 (January 2020) with a Golang HTTP server on Scratch*
|
|
|
|
[](https://hub.docker.com/r/qmcgaw/stackedit/)
|
|
|
|
[](https://hub.docker.com/r/qmcgaw/stackedit)
|
|
|
|
[](https://github.com/qdm12/stackedit-docker/commits)
|
|
[](https://github.com/qdm12/stackedit-docker/commits)
|
|
[](https://github.com/qdm12/stackedit-docker/issues)
|
|
|
|
[](https://hub.docker.com/r/qmcgaw/stackedit)
|
|
[](https://hub.docker.com/r/qmcgaw/stackedit)
|
|
[](https://hub.docker.com/r/qmcgaw/stackedit)
|
|
|
|
[](https://microbadger.com/images/qmcgaw/stackedit)
|
|
[](https://microbadger.com/images/qmcgaw/stackedit)
|
|
|
|
[](https://paypal.me/qdm12)
|
|
|
|
| Image size | RAM usage | CPU usage |
|
|
| --- | --- | --- |
|
|
| 34.1MB | 7MB | Very low |
|
|
|
|
## Features
|
|
|
|
- [Stackedit features](https://github.com/benweet/stackedit/blob/master/README.md#stackedit-can)
|
|
- Lightweight image based on:
|
|
- [Stackedit 5.14.5](https://github.com/benweet/stackedit)
|
|
- [Scratch](https://hub.docker.com/_/scratch)
|
|
- Golang simple HTTP static server
|
|
- Running without root
|
|
- Built-in Docker healthcheck
|
|
- Nice emojis in the logs...
|
|
|
|
## Setup
|
|
|
|
1. <details><summary>CLICK IF YOU HAVE AN ARM DEVICE</summary><p>
|
|
|
|
You need to build the Docker image yourself using `git` and `docker`
|
|
|
|
```sh
|
|
docker build -t qmcgaw/stackedit https://github.com/qdm12/stackedit-docker.git
|
|
```
|
|
|
|
</p></details>
|
|
|
|
1. Use the following command:
|
|
|
|
```sh
|
|
docker run -d -p 8000:8000/tcp qmcgaw/stackedit
|
|
```
|
|
|
|
You can also use [docker-compose.yml](https://github.com/qdm12/stackedit-docker/blob/master/docker-compose.yml) with:
|
|
|
|
```sh
|
|
docker-compose up -d
|
|
```
|
|
|
|
1. Access at [http://localhost:8000](http://localhost:8000)
|
|
|
|
## Environment variables
|
|
|
|
- `LISTENING_PORT` to change the internal HTTP server listening port if you need to
|
|
- `ROOT_URL` to define a root URL (i.e. `/mypath`) if you use a reverse proxy such as Nginx
|
|
|
|
## Acknowledgements
|
|
|
|
Credits to the [developers](https://github.com/benweet/stackedit/graphs/contributors) of [StackEdit](https://stackedit.io/)
|
|
|
|
## TODOs
|
|
|
|
- [ ] Configuration of Stackedit with env variables
|
|
- [ ] Travis CI build cross CPU arch
|