Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aldor007/mort
Storage and image processing server written in Go
https://github.com/aldor007/mort
crop-image docker dockerfile go golang image-processing jpeg libvips png resize resize-images s3 storage tranform webp
Last synced: 7 days ago
JSON representation
Storage and image processing server written in Go
- Host: GitHub
- URL: https://github.com/aldor007/mort
- Owner: aldor007
- License: mit
- Created: 2017-11-19T13:37:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T08:40:30.000Z (over 1 year ago)
- Last Synced: 2024-12-08T15:04:24.784Z (14 days ago)
- Topics: crop-image, docker, dockerfile, go, golang, image-processing, jpeg, libvips, png, resize, resize-images, s3, storage, tranform, webp
- Language: Go
- Homepage:
- Size: 6.31 MB
- Stars: 512
- Watchers: 17
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-go - mort - Storage and image processing server written in Go. (Images / Search and Analytic Databases)
- awesome-go-extra - mort - 11-19T13:37:58Z|2022-08-19T23:16:07Z| (Images / Advanced Console UIs)
- awesome-go-zh - mort
- awesome-go - mort - Storage and image processing server written in Go - ★ 335 (Images)
README
# Mort
[](https://github.com/aldor007/mort/actions/workflows/ci.yaml) [](https://codecov.io/gh/aldor007/mort) [](https://goreportcard.com/report/github.com/aldor007/mort) [](https://godoc.org/github.com/aldor007/mort) [](https://github.com/aldor007/mort/releases) [](https://github.com/aldor007/mort/blob/master/LICENSE.md)
An S3-compatible image processing server written in Go. Still in active development.
# Features
* HTTP server
* Resize, Rotate, SmartCrop
* Convert (JPEG, PNG , BMP, Webp)
* Multiple storage backends (disk, S3, http)
* Fully modular
* S3 API for listing and uploading files
* Requests collapsing
* Build in rate limiter
* HTTP Range and Conditional requests
* Compression (gzip, brotli)
* Env variables driven configuration
* Write you own transform parser using [tengo](https://github.com/d5/tengo)
* cloudinary image transformation and upload
And more see [changelog](CHANGELOG.md) for more info
# Demo
-------
[Original image](https://mort.mkaciuba.com/demo/img.jpg)
Click on result image to see URL. More examples can be found in [Image Operations list](doc/Image-Operations.md)
Description
Result (to see result click on image)
preset: small
(preserve aspect ratio)
width: 75
preset: blur
resize image (preserve aspect ratio)
width: 700blur image with sigma 5.0
preset: webp
-
resize image (preserve aspect ratio)
width: 1000 and change format to webp
preset: watermark
-
resize image (preserve aspect ratio)
width: 1300 and add watermark
# Usage
Mort can be used directly from the Internet and behind any proxy.
## Install
```bash
go get github.com/aldor007/mort/cmd/
```
## Command line help
```bash
$ ./mort
Usage of mort
-config string
Path to configuration (default "/etc/mort/mort.yml")
```
## Configuration
Example configuration used for providing demo images:
```yaml
headers: # add or overwrite all response headers of given status. This field is optional
- statusCodes: [200]
values:
"cache-control": "max-age=84000, public"
buckets: # list of available buckets
demo: # bucket name
keys: # list of S3 keys (optional)
- accessKey: "access"
secretAccessKey: "random"
transform: # config for transforms
path: "\\/(?P[a-z0-9_]+)\\/(?P[a-z0-9-\\.]+)" # regexp for transform path
kind: "presets-query" # type of transform or "query"
presets: # list of presets
small:
quality: 75
filters:
thumbnail:
width: 150
blur:
quality: 80
filters:
thumbnail:
width: 700
blur:
sigma: 5.0
webp:
quality: 100
format: webp
filters:
thumbnail:
width: 1000
watermark:
quality: 100
filters:
thumbnail:
width: 1300
watermark:
image: "https://i.imgur.com/uomkVIL.png"
position: "top-left"
opacity: 0.5
smartcrop:
quality: 80
filters:
crop:
width: 200
height: 200
storages:
basic: # retrieve originals from s3
kind: "s3"
accessKey: "acc"
secretAccessKey: "sec"
region: ""
endpoint: "http://localhost:8080"
transform: # and store it on disk
kind: "local-meta"
rootPath: "/var/www/domain/"
pathPrefix: "transform"
```
List of all image operations can be found in [Image-Operations.md](doc/Image-Operations.md)
More details about configuration can be found in [Configuration.md](doc/Configuration.md)
## Write you own URL parser
- Using golang (custom mort version needed) [UrlParsers.md](doc/UrlParsers.md)
- Using tengo [TengoUrlParser.md](doc/TengoUrlParser.md)
## Docker
See [Dockerfile](Dockerfile) for image details.
Pull docker image
```bash
docker pull ghcr.io/aldor007/mort
```
### Create you custom docker deployment
Create Dockerfile or use Dockerfile.service
```
# Dockerfile.service
FROM ghcr.io/aldor007/mort:latest
# add your config
ADD config.yml /etc/mort/mort.yml
```
Build container
```bash
docker build -f Dockerfile.service -t myusername/mort
```
Run docker
```
docker run -p 8080:8080 myusername/mort
```
Full example you can find [here](example/)
# Development
1. Make sure you have a Go language compiler >= 1.9 (required) and git installed.
2. Install libvips like described on [bimg page](https://github.com/h2non/bimg)
3. Ensure your GOPATH is properly set.
4. Download it
```bash
git clone https://github.com/aldor007/mort.git $GOPATH/src/github.com/aldor007/mort
cd $GOPATH/src/github.com/aldor007/mort
```
5. Install dependencies:
```bash
go mod vendor
```
Run unit tests:
```bash
make unit
```
Run integration tests:
```bash
make integrations
```
If you encounter following problem `go build gopkg.in/h2non/bimg.v1: invalid flag in pkg-config --cflags: -Xpreprocessor`
while running tests in your IDE add this to your environment:
```
export CGO_CFLAGS_ALLOW="-Xpreprocessor"
```
Run tests using docker image
```bash
make docker-tests
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Inspirations
* [picfit](https://github.com/thoas/picfit)
* [imaginary](https://github.com/h2non/imaginary)