linuxrun commited on
Commit
a6ece0d
·
verified ·
1 Parent(s): 62be781

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -158
README.md CHANGED
@@ -1,158 +1,9 @@
1
- ![ConvertX](images/logo.png)
2
-
3
- # ConvertX
4
-
5
- [![Docker](https://github.com/C4illin/ConvertX/actions/workflows/docker-publish.yml/badge.svg?branch=main)](https://github.com/C4illin/ConvertX/actions/workflows/docker-publish.yml)
6
- [![ghcr.io Pulls](https://img.shields.io/badge/dynamic/json?logo=github&url=https%3A%2F%2Fipitio.github.io%2Fbackage%2FC4illin%2FConvertX%2Fconvertx.json&query=%24.downloads&label=ghcr.io%20pulls&cacheSeconds=14400)](https://github.com/C4illin/ConvertX/pkgs/container/ConvertX)
7
- [![Docker Pulls](https://img.shields.io/docker/pulls/c4illin/convertx?style=flat&logo=docker&label=dockerhub%20pulls&link=https%3A%2F%2Fhub.docker.com%2Frepository%2Fdocker%2Fc4illin%2Fconvertx%2Fgeneral)](https://hub.docker.com/r/c4illin/convertx)
8
- [![GitHub Release](https://img.shields.io/github/v/release/C4illin/ConvertX)](https://github.com/C4illin/ConvertX/pkgs/container/convertx)
9
- ![GitHub commits since latest release](https://img.shields.io/github/commits-since/C4illin/ConvertX/latest)
10
- ![GitHub repo size](https://img.shields.io/github/repo-size/C4illin/ConvertX)
11
- ![Docker container size](https://ghcr-badge.egpl.dev/c4illin/convertx/size?color=%230375b6&tag=latest&label=image+size&trim=)
12
-
13
- <a href="https://trendshift.io/repositories/13818" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13818" alt="C4illin%2FConvertX | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
14
-
15
- <!-- ![Dev image size](https://ghcr-badge.egpl.dev/c4illin/convertx/size?color=%230375b6&tag=main&label=dev+image&trim=) -->
16
-
17
- A self-hosted online file converter. Supports over a thousand different formats. Written with TypeScript, Bun and Elysia.
18
-
19
- ## Features
20
-
21
- - Convert files to different formats
22
- - Process multiple files at once
23
- - Password protection
24
- - Multiple accounts
25
-
26
- ## Converters supported
27
-
28
- | Converter | Use case | Converts from | Converts to |
29
- | --------------------------------------------------------------- | ---------------- | ------------- | ----------- |
30
- | [Inkscape](https://inkscape.org/) | Vector images | 7 | 17 |
31
- | [libjxl](https://github.com/libjxl/libjxl) | JPEG XL | 11 | 11 |
32
- | [resvg](https://github.com/RazrFalcon/resvg) | SVG | 1 | 1 |
33
- | [Vips](https://github.com/libvips/libvips) | Images | 45 | 23 |
34
- | [libheif](https://github.com/strukturag/libheif) | HEIF | 2 | 4 |
35
- | [XeLaTeX](https://tug.org/xetex/) | LaTeX | 1 | 1 |
36
- | [Calibre](https://calibre-ebook.com/) | E-books | 26 | 19 |
37
- | [LibreOffice](https://www.libreoffice.org/) | Documents | 41 | 22 |
38
- | [Dasel](https://github.com/TomWright/dasel) | Data Files | 5 | 4 |
39
- | [Pandoc](https://pandoc.org/) | Documents | 43 | 65 |
40
- | [msgconvert](https://github.com/mvz/email-outlook-message-perl) | Outlook | 1 | 1 |
41
- | [dvisvgm](https://dvisvgm.de/) | Vector images | 4 | 2 |
42
- | [ImageMagick](https://imagemagick.org/) | Images | 245 | 183 |
43
- | [GraphicsMagick](http://www.graphicsmagick.org/) | Images | 167 | 130 |
44
- | [Assimp](https://github.com/assimp/assimp) | 3D Assets | 77 | 23 |
45
- | [FFmpeg](https://ffmpeg.org/) | Video | ~472 | ~199 |
46
- | [Potrace](https://potrace.sourceforge.net/) | Raster to vector | 4 | 11 |
47
- | [VTracer](https://github.com/visioncortex/vtracer) | Raster to vector | 8 | 1 |
48
-
49
- <!-- many ffmpeg fileformats are duplicates -->
50
-
51
- Any missing converter? Open an issue or pull request!
52
-
53
- ## Deployment
54
-
55
- > [!WARNING]
56
- > If you can't login, make sure you are accessing the service over localhost or https otherwise set HTTP_ALLOWED=true
57
-
58
- ```yml
59
- # docker-compose.yml
60
- services:
61
- convertx:
62
- image: ghcr.io/c4illin/convertx
63
- container_name: convertx
64
- restart: unless-stopped
65
- ports:
66
- - "3000:3000"
67
- environment:
68
- - JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() if unset
69
- # - HTTP_ALLOWED=true # uncomment this if accessing it over a non-https connection
70
- volumes:
71
- - ./data:/app/data
72
- ```
73
-
74
- or
75
-
76
- ```bash
77
- docker run -p 3000:3000 -v ./data:/app/data ghcr.io/c4illin/convertx
78
- ```
79
-
80
- Then visit `http://localhost:3000` in your browser and create your account. Don't leave it unconfigured and open, as anyone can register the first account.
81
-
82
- If you get unable to open database file run `chown -R $USER:$USER path` on the path you choose.
83
-
84
- ### Environment variables
85
-
86
- All are optional, JWT_SECRET is recommended to be set.
87
-
88
- | Name | Default | Description |
89
- | ---------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
90
- | JWT_SECRET | when unset it will use the value from randomUUID() | A long and secret string used to sign the JSON Web Token |
91
- | ACCOUNT_REGISTRATION | false | Allow users to register accounts |
92
- | HTTP_ALLOWED | false | Allow HTTP connections, only set this to true locally |
93
- | ALLOW_UNAUTHENTICATED | false | Allow unauthenticated users to use the service, only set this to true locally |
94
- | AUTO_DELETE_EVERY_N_HOURS | 24 | Checks every n hours for files older then n hours and deletes them, set to 0 to disable |
95
- | WEBROOT | | The address to the root path setting this to "/convert" will serve the website on "example.com/convert/" |
96
- | FFMPEG_ARGS | | Arguments to pass to ffmpeg, e.g. `-preset veryfast` |
97
- | HIDE_HISTORY | false | Hide the history page |
98
- | LANGUAGE | en | Language to format date strings in, specified as a [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) |
99
- | UNAUTHENTICATED_USER_SHARING | false | Shares conversion history between all unauthenticated users |
100
- | MAX_CONVERT_PROCESS | 0 | Maximum number of concurrent conversion processes allowed. Set to 0 for unlimited. |
101
-
102
- ### Docker images
103
-
104
- There is a `:latest` tag that is updated with every release and a `:main` tag that is updated with every push to the main branch. `:latest` is recommended for normal use.
105
-
106
- The image is available on [GitHub Container Registry](https://github.com/C4illin/ConvertX/pkgs/container/ConvertX) and [Docker Hub](https://hub.docker.com/r/c4illin/convertx).
107
-
108
- | Image | What it is |
109
- | -------------------------------------- | -------------------------------- |
110
- | `image: ghcr.io/c4illin/convertx` | The latest release on ghcr |
111
- | `image: ghcr.io/c4illin/convertx:main` | The latest commit on ghcr |
112
- | `image: c4illin/convertx` | The latest release on docker hub |
113
- | `image: c4illin/convertx:main` | The latest commit on docker hub |
114
-
115
- ![Release image size](https://ghcr-badge.egpl.dev/c4illin/convertx/size?color=%230375b6&tag=latest&label=release+image&trim=)
116
- ![Dev image size](https://ghcr-badge.egpl.dev/c4illin/convertx/size?color=%230375b6&tag=main&label=dev+image&trim=)
117
-
118
- <!-- Dockerhub was introduced in 0.9.0 and older releases -->
119
-
120
- ### Tutorial
121
-
122
- > [!NOTE]
123
- > These are written by other people, and may be outdated, incorrect or wrong.
124
-
125
- Tutorial in french: <https://belginux.com/installer-convertx-avec-docker/>
126
-
127
- Tutorial in chinese: <https://xzllll.com/24092901/>
128
-
129
- ## Screenshots
130
-
131
- ![ConvertX Preview](images/preview.png)
132
-
133
- ## Development
134
-
135
- 0. Install [Bun](https://bun.sh/) and Git
136
- 1. Clone the repository
137
- 2. `bun install`
138
- 3. `bun run dev`
139
-
140
- Pull requests are welcome! See open issues for the list of todos. The ones tagged with "converter request" are quite easy. Help with docs and cleaning up in issues are also very welcome!
141
-
142
- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for commit messages.
143
-
144
- ## Contributors
145
-
146
- <a href="https://github.com/C4illin/ConvertX/graphs/contributors">
147
- <img src="https://contrib.rocks/image?repo=C4illin/ConvertX" alt="Image with all contributors"/>
148
- </a>
149
-
150
- ## Star History
151
-
152
- <a href="https://github.com/C4illin/ConvertX/stargazers">
153
- <picture>
154
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=C4illin/ConvertX&type=Date&theme=dark" />
155
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=C4illin/ConvertX&type=Date" />
156
- <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=C4illin/ConvertX&type=Date" />
157
- </picture>
158
- </a>
 
1
+ ---
2
+ title: convert
3
+ emoji: 🐢
4
+ colorFrom: purple
5
+ colorTo: yellow
6
+ sdk: docker
7
+ pinned: false
8
+ app_port: 3000
9
+ ---