* chore: upgrade toolchain to Vite 8, Vue 3.5, Vitest 4, TypeScript 6 and pnpm 11; adopt oxlint/oxfmt - vite 4 -> 8.1.3 (rolldown-based: build.rollupOptions -> rolldownOptions, drop optimizeDeps.esbuildOptions), @vitejs/plugin-vue 4 -> 6, plugin-vue-jsx 3 -> 5 - vue 3.3 -> 3.5.39, vue-tsc 1.8 -> 3.3.6, vitest 0.34 -> 4.1.9, jsdom 22 -> 29 - typescript 5.2 -> 6.0.3 with moduleResolution=bundler (baseUrl/node10 are hard errors in TS 6, removed in TS 7); TS 7 RC not adoptable: its native tsc lacks the JS compiler API vue-tsc needs (vuejs/language-tools#5381) - unocss 0.57 -> 66 (presetUno -> presetWind3), unplugin-* to current majors (unplugin-vue-components dtsTsx disabled: emits invalid declarations for dotted component names) - @vueuse/head 1.0.0 -> 1.3.1 (1.0.0 silently stopped applying page titles under Vue 3.5) - replace ESLint (@antfu config) + Prettier with oxlint + oxfmt; configs mirror the previous style rules. Existing files are intentionally NOT mass-reformatted (oxfmt has no brace-style/operator-position options to match the old @antfu style) — only files with real changes are formatted - pnpm 9 -> 11.10.0: settings move to pnpm-workspace.yaml, fresh lockfile passing supply-chain policies, explicit allowBuilds decisions, blockExoticSubdeps off (xlsx CDN override patches vulnerable npm 0.18.5) - isolated-vm (17 MB) and onnxruntime-node (208 MB) stubbed via overrides: native-only transitives already aliased to an empty module for the bundle - elliptic overridden to npm ^6.6.1 (github fork tarball of webcrypto-liner-shim unreachable from the build environment) - CI: node 22 -> 24, all actions pinned to latest patch releases, automatic Vercel workflows disabled (fork deploys via Vercel Git integration), vercel.json: git.deploymentEnabled removed, buildCommand skips no-op vue-tsc - Dockerfile: node:24-alpine, pnpm@11, ship pnpm-workspace.yaml and stubs Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 * fix: resolve type, lint and runtime issues from the toolchain upgrade vue-tsc 3 checks templates far more strictly than 1.8 and TS 5.7+ made Uint8Array generic over its backing buffer. Widen shared component props (InputCopyable, c-table, c-input-text, UnitsConverter), convert values at call sites, fix invalid local .d.ts declarations, and repair issues the new tooling exposed: - WireGuard generator: pre-shared-keys checkbox used v-model:value which never binds on a standalone n-checkbox (now v-model:checked) - mask-closable="false" string attrs became real boolean bindings in countdown/cron-alarm/time-alarm - v-model casts (x as any) fail to compile under plugin-vue 6 + rolldown; replaced with :value/@update:value split bindings - invalid '::ffff::' IPv6 literal in ipv6registry.json, exposed by stricter parsing in cidr-tools 11.3 (IPv4-mapped range never matched) - fanger pinned to 0.3.1 (0.3.2 published without dist/) - countries-and-timezones namespace imports, Vitest 4 snapshot format, invalid ul-inside-p HTML in dead-pixel, test assertion outside it() block vue-tsc clean; oxlint clean; vitest 665/665; vite build + PWA OK; Playwright e2e 100/100; all 457 tool routes render without errors Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 * chore: drop whole-tree oxfmt from precommit instructions The tree deliberately keeps its existing @antfu-era formatting; running 'pnpm fmt' (oxfmt over all of src) would reformat ~800 untouched files. Format only the files you change, or run 'pnpm fmt' in a dedicated PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 * fix: escape backslashes before dots in parquet column keys CodeQL flagged incomplete string escaping (js/incomplete-sanitization): escaping '.' to '\.' without first escaping existing backslashes makes column names containing backslashes ambiguous in naive-ui's nested-key syntax. Escape backslashes first. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 * test: allow 30s for initial mermaid render in e2e mermaid is a large lazy-loaded chunk; webkit on cold CI runners exceeds Playwright's default 5s expect timeout even across retries. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 * refactor: replace 'as any' input type casts with proper typings Copilot review on the upstream PR flagged the casts. c-input-text renders any non-password type as a text input, so widen its type union to include 'url' instead of casting; for naive-ui's NInput use the documented input-props to set the native input's type=number. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 (cherry picked from commit 906820336b271aa6d96ecb11efa03219bf869475) * fix: reconcile lockfile with upstream sync; repair date-picker typing in Docker Label Generator - fold upstream's new CodeMirror/picomatch dependencies into the pnpm 11 lockfile; add @lezer/highlight to optimizeDeps (kept from upstream) - dockerfile-label-generator: n-date-picker emits a number timestamp, not a Date — calling toISOString() on it would throw at runtime the moment a date was picked. Type as number and convert via new Date() - drop stray tsconfig.vite-config.tsbuildinfo build artifact; ignore *.tsbuildinfo vue-tsc clean; oxlint clean; vitest 665/665; vite build OK Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 * chore: keep upstream Vercel CLI deployment setup The fork-specific Vercel changes (Git-integration deploys, disabled CLI workflows, build:vercel command) are excluded from the upstream contribution; upstream deploys via its own Vercel CLI workflows. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 (cherry picked from commit ed182ec55648358556343e60e1667129acdbb966) * fix: escape backslashes in Docker label values; raise global e2e expect timeout - dockerfile-label-generator escaped quotes without escaping existing backslashes first (CodeQL js/incomplete-sanitization, same class as the parquets-reader fix): a value ending in a backslash would break the generated LABEL quoting - playwright: 15s global expect timeout — first paint of heavy lazy chunks exceeds the 5s default on slow CI browsers (webkit), which intermittently failed title assertions across retries Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M6deEDJXFzgDzPiYPAcsv1 (cherry picked from commit 5b3822e10113a49bc519661a5b01ad62660d56a9) * Update .gitignore to include specific file types * Add stats.html to .gitignore * Delete tsconfig.vite-config.tsbuildinfo * Delete stats.html --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: sharevb <sharevb@gmail.com>
13 KiB
BREAKING CHANGE for Container Image
Since the base image is now nginx-unpriviledged the container will now listen to port 8080 and not 80. So you need to update your port mapping, i.e. from 8080:80 to 8080:8080.
You can override listening port using environment variable PORT (docker option -e PORT=8888).
If the container needs to listen to IPv6, it needs to be enabled: https://serverfault.com/questions/1147296/how-to-enable-ipv6-on-ubuntu-20-04. Alternatively, you can mount your own nginx.conf own using docker option -v "./nginx.conf:/etc/nginx/templates/default.conf.template" (with listen [::]:8080; removed)
Build requirements
To build this project, you need around 16GB (as it builds on Github workers). Below, you will get some out of memory or node allocation failed.
PR Welcome
Especially for UI improvements and translation. And for anything else.
Want to support this fork of IT Tools: Buy me a coffee
HTTPS is recommended
Some tools like PGP encryption rely on WebCrypto API that is only available in HTTPS/SSL. Also, if you want to use PWA, HTTPS is required.
So even on internal installations, you should enable HTTPS using Let's Encrypt using DNS Challenge
Some docs about DNS Challenge:
- https://medium.com/@life-is-short-so-enjoy-it/homelab-nginx-proxy-manager-setup-ssl-certificate-with-domain-name-in-cloudflare-dns-732af64ddc0b
- https://doc.traefik.io/traefik/user-guides/docker-compose/acme-dns/
- https://medium.com/@svenvanginkel/traefik-letsencrypt-dns01-challenge-with-ovhcloud-52f2a2c6d08a
Related doc for CyberPanel: https://community.cyberpanel.net/t/reverse-proxy-traffic-to-docker-container-on-cyberpanel/30644
Check out these change here: https://sharevb-it-tools.vercel.app/ or https://sharevb.github.io/it-tools/
You can use my image in your docker-compose/quadlet file if you want an up-to-date version of it-tools (with my PR and some of others) until the main branch has been updated.
- github action triggers on every push to this branch - view package here
(Thanks to gitmotion for this model of README fork)
Contributors
Big thanks to all the people who have already contributed!
Development under Windows
Use of WSL2 is recommended to develop using VSCode on Windows. Direct development is tricky (because of some dependencies)
Added features
- Almost all tools PR, 192 of mine, of original it-tools
- 95% of issues if original it-tools
- Full UI translation in many language (Google Translated)
- Many new tools
- Many bug fixes and enhancements
- Many customizations (Docker version), see below
Container images
GitHub Container Registry: ghcr.io/sharevb/it-tools:latest
Docker Hub: sharevb/it-tools:latest
docker run --pull always --restart unless-stopped -p 8080:8080 sharevb/it-tools:latest
Other existing docker tags: latest-en (english only)
Use in Docker Compose file
services:
it-tools:
container_name: it-tools
image: sharevb/it-tools:latest
pull_policy: always
restart: unless-stopped
ports:
- 8080:8080
Use in Podman Quadlet file
[Unit]
Description=IT Tools container
After=network-online.target
[Container]
AutoUpdate=registry
Image=ghcr.io/sharevb/it-tools:latest
PublishPort=8080:8080
Label=io.containers.autoupdate=registry
[Install]
WantedBy=multi-user.target default.target
[Service]
Restart=always
Filter tools and add home custom content
You can add custom content in Home page by mounting a home.custom.md in /usr/share/nginx/html.
You can filter available tools by mounting tools-filter.json in /usr/share/nginx/html. It can contains the following filtering regex:
{
"excludeCategoryFilterRegex": "",
"includeCategoryFilterRegex": "",
"excludeToolsFilterRegex": "",
"includeToolsFilterRegex": ""
}
Category matches on category (English) names ; Tools matches on tools path/url.
See docker-tools-filter-and-home-content
Add custom external tools
You can add custom external tools (href or markdownContent) by mounting a external-tools.json in /usr/share/nginx/html with the following structure:
[
{
"name": "GitHub",
"path": "/github",
"description": "Link to Github",
"keywords": ["github"],
"category": "Links",
"href": "https://github.com"
},
{
"name": "Some text",
"path": "/some-text",
"description": "Some description",
"keywords": ["some"],
"category": "Links",
"markdownContent": "Some useful **text**\n\nin *markdown*"
}
]
See docker-tools-filter-and-home-content
Setting default tools parameters / default UI language at runtime
You can set default tool parameters by mounting a tools-settings.json in /usr/share/nginx/html.
It is a two level json, with the first level being for tool name and the second level for parameter name:
{
"regex-tester": {
"multi": true,
"regex": "some regex",
"global": false
}
}
You can find tool name and parameter name in the tools source code src/tools subfolder :
- example pattern for
const global = useQueryParamOrStorage({ storageName: 'regex-tester:g', name: 'global', defaultValue: true });:
{
"regex-tester": {
"global": false
}
}
- example pattern for
const value = useQueryParam({ tool: 'barcode-gen', name: 'text', defaultValue: '123456789' });:
{
"barcode-gen": {
"text": "4356"
}
}
- example pattern for
const width = useITStorage('ascii-text-drawer:width', 80);:
{
"ascii-text-drawer": {
"width": 80
}
}
To define the default UI language, add a default_locale key to json:
{
"default_locale": "fr"
}
To build using a custom default language:
docker build -t it-tools-fr --build-arg VITE_LANGUAGE=fr .
docker run -d --name it-tools-fr --restart unless-stopped -p 8080:8080 it-tools-fr
Build container image for a custom subfolder
According to https://github.com/sharevb/it-tools/pull/461#issuecomment-1602506049 and https://github.com/CorentinTh/it-tools/pull/461:
docker build -t it-tools --build-arg BASE_URL="/my-folder/" .
docker run -d --name it-tools --restart unless-stopped -p 8080:8080 it-tools
Then if you go to http://localhost:8080 you'll get a blank page, but opening the DevTools (& refreshing) you'll notice in the Network tab that the app is trying to fetch assets from /my-folder/...
So you would need to put another server in front of it, like Nginx Proxy Manager, Traefik, caddy etc. Then setup a reverse proxy pass using /my-folder
Docker compose for hosting in a /it-tools/ subfolder
For /it-tools/ subfolder, you can use baseurl-it-tools tag.
See sample of docker-compose.yml and nginx.conf, this docker image needs to have another reverse proxy in front of it, like Nginx Proxy Manager, Traefik, caddy etc.
Setup a reverse proxy pass using /it-tools/. And you should be able to access it-tools in /it-tools/ of your server.
An example of nginx reverse proxy configuration is available at: https://github.com/sharevb/it-tools/tree/chore/all-my-stuffs/docker-subfolder-sample
To run the sample:
git clone https://github.com/sharevb/it-tools
cd it-tools/docker-subfolder-sample/
docker compose up
Then navigate to http://localhost:8080/it-tools/
To build using a custom folder:
BASE_URL="/it-tools/" pnpm build- Rename the generated
distfolder toit-toolsand serve onhttps://your-domain.com/it-tools
To build for GitHub Pages:
- Enable GitHub Pages build and deployment option in your fork, under Settings > Pages and select GitHub Actions as the source
- Add the following GitHub action to your repo: https://github.com/sharevb/it-tools/tree/chore/all-my-stuffs/.github/workflows/sharevb-github-pages-publish.yml
To add authentication
Assuming you're already hosting it-tools behind a reverse proxy, you can configure forward-auth and enforce authentication from the reverse proxy
- Official guides with nginx. Guides with other reverse proxy setups are available
- Step-by-step setup guide with nginx-proxy-manager
(thanks @jogerj)
Deploy as LXC container
In Proxmox VE, you can use docker image directly:
sudo lxc-create -n sharevb-it-tools -t oci -- --url docker://ghcr.io/sharevb/it-tools:latest
Contribute
Recommended IDE Setup
To install VSCode in WSL2 (Windows), see: https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-vscode
VSCode with the following extensions:
- Volar (and disable Vetur)
- TypeScript Vue Plugin (Volar).
- Oxc (oxlint + oxfmt)
- i18n Ally
with the following settings:
{
"editor.formatOnSave": true,
"editor.defaultFormatter": "oxc.oxc-vscode",
"editor.codeActionsOnSave": {
"source.fixAll.oxc": "always"
},
"i18n-ally.localesPaths": ["locales", "src/tools/*/locales"],
"i18n-ally.keystyle": "nested"
}
Type Support for .vue Imports in TS
TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:
- Disable the built-in TypeScript Extension
- Run
Extensions: Show Built-in Extensionsfrom VSCode's command palette - Find
TypeScript and JavaScript Language Features, right click and selectDisable (Workspace)
- Run
- Reload the VSCode window by running
Developer: Reload Windowfrom the command palette.
Project Setup
pnpm install --ignore-scripts
Compile and Hot-Reload for Development
pnpm dev
Type-Check, Compile and Minify for Production
pnpm build
Run Unit Tests with Vitest
pnpm test
Lint with Oxlint
pnpm lint
Format with Oxfmt
pnpm fmt
Ensure CI (lock, oxlint, typecheck) will succeed
Before submitting a PR, run:
pnpm install --ignore-scripts && pnpm lint:fix && pnpm typecheck
Create a new tool
To create a new tool, there is a script that generate the boilerplate of the new tool, simply run:
pnpm run script:create:tool my-tool-name
It will create a directory in src/tools with the correct files. You will need to fill src/tools/_my-tool-name_/index.ts with tool name, category, description... and then develop the tool.
Installation methods
Local installation required installing first: python3 make g++
| Container Image | Local Installation |
|---|---|
GitHub Container Registry: ghcr.io/sharevb/it-tools:latestDocker Hub: sharevb/it-tools:latest |
sudo apt-get install python3 make g++ && git clone -b chore/all-my-stuffs https://github.com/sharevb/it-tools.git && cd it-tools/ && pnpm i --ignore-scripts && pnpm dev |
| replace your current image with this image | copy & paste oneliner (from github repo) |
| You may need to clear cache and hard reload to get new features loading | Installing packages for the first time may take some time; please wait until it finishes |
License
This project is under the GNU GPLv3.