gnh1201/ffmpeg-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.adoc

Browse Source
This commit is contained in:
Namhyeon Go 2024-05-11 03:20:31 +09:00 committed by GitHub
parent 0b81d27c44
commit 4fcf29634f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.adoc
View File

@ -61,18 +61,6 @@ FFMPEG API is provided as Docker image for easy consumption.
* When running on Docker/Kubernetes, port binding can be different than default 3000. Use _EXTERNAL_PORT_ to set up external port in returned URLs in extracted images JSON:
** `docker run -it --rm -p 3001:3000 -e EXTERNAL_PORT=3001 kazhar/ffmpeg-api`
=== In my case
```bash
cd /usr/local/src
git clone https://github.com/gnh1201/ffmpeg-api
cd ffmpeg-api
docker build -t gnh1201/ffmpeg-api .
sudo mkdir /var/cache/ffmpeg-api
sudo chmod -R 777 /var/cache/ffmpeg-api
sudo docker run -itd --rm -p 127.0.0.1:3000:3000 -v /var/cache/ffmpeg-api:/tmp -e KEEP_ALL_FILES=false -e LOG_LEVEL=debug gnh1201/ffmpeg-api # OR `-p 0.0.0.0:3000:3000`
```
== Usage
Input file to FFMPEG API can be anything that ffmpeg supports. See https://www.ffmpeg.org/general.html#Supported-File-Formats_002c-Codecs-or-Features[ffmpeg docs for supported formats].
@ -132,3 +120,27 @@ Probe audio/video/image files using the API.
Originally developed by https://github.com/surebert[Paul Visco].
Changes include new functionality, updated Node.js version, Docker image based on Alpine, logging and other major refactoring.
== Use case
=== Example of creating a container
```bash
cd /usr/local/src
git clone https://github.com/gnh1201/ffmpeg-api
cd ffmpeg-api
docker build -t gnh1201/ffmpeg-api .
sudo mkdir /var/cache/ffmpeg-api
sudo chmod -R 777 /var/cache/ffmpeg-api
sudo docker run -itd --rm -p 127.0.0.1:3000:3000 -v /var/cache/ffmpeg-api:/tmp -e KEEP_ALL_FILES=false -e LOG_LEVEL=debug gnh1201/ffmpeg-api # OR `-p 0.0.0.0:3000:3000`
```
=== Example of applications
* https://github.com/gnh1201/topic-activitypub
== Report abuse
* ActivityPub @gnh1201@catswords.social https://catswords.social/@gnh1201
* abuse@catswords.net