* feat(git-memo): add i18n support and Chinese translation - Dynamically load locale-specific markdown content - Add comprehensive Chinese translation for git memo - Apply theme-aware styles for tables and links * feat(git-semantic-commit-memo): add i18n support and table styling Load memo markdown dynamically based on locale, add Chinese translation, and apply theme-aware styles for tables and links. * feat(jq-memo): add i18n support and Chinese memo Support multiple languages for the jq memo tool by dynamically loading locale-specific markdown files based on the current i18n locale, and add the Chinese translation (jq.zh.md). * feat(jsonpath-memo): add i18n support for memo component Dynamically load localized markdown files based on the current locale, falling back to the default English memo. * feat(markdown-cheatsheet): add i18n support with Chinese content Load locale-specific memo content dynamically using glob import and provide the Chinese translation for the Markdown cheatsheet. * style(markdown-cheatsheet): add table and link styling Add borders, padding, and collapse for tables, and set link color using theme variables. * feat(nano-memo): add i18n support and table/link styling - Dynamically load locale-specific content markdown based on the current language - Add Chinese translation content file - Apply theme-aware border and link colors for tables and links * feat(nginx-memo): add i18n support and styling improvements - dynamically load localized content based on current locale - add Chinese (zh) translation for nginx memo - add table and link styling using theme variables - fallback to default content if localized version is missing * feat(powershell-memo): add i18n support and Chinese translation Load localized Markdown content based on the current locale, falling back to the default English version. Include the complete Chinese translation file. * feat(sed-memo): add i18n support and zh docs * feat(tmux-memo): add i18n support and Chinese translation - Dynamically load locale-specific markdown content - Add Chinese translation (tmux-memo.content.zh.md) - Fall back to default content if locale file not found * feat(vim-memo): add i18n support and zh content - Implement dynamic locale-based content loading - Add comprehensive Chinese translation file - Update styles for tables and links using theme variables * feat(xpath-memo): support locale-based markdown loading Load the appropriate markdown file based on the current i18n locale, falling back to the default when a localized version is not available. * feat(zellij-memo): add i18n support for memo content Load locale-specific markdown files dynamically based on the current language setting, falling back to the default when a translation is unavailable. * feat(chmod-memo): add i18n support and Chinese docs - load locale-specific markdown via dynamic imports - add chmod.zh.md with detailed Chinese documentation - fall back to default chmod.md if no locale match * feat(screen-memo): add i18n support with Chinese translation Add dynamic locale-based markdown loading for the Screen Memo tool and include the complete Chinese (zh) translation. * feat(regex-memo): add i18n support with Chinese translation Load locale-specific markdown content dynamically based on the selected language.
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
Use with companion Self Hosted docker services
Some tools requires additional docker services: HTTPS/DNS tools/Ping, HTML to PDF, Docker Image Download, Multi Links Download, Short Url Expander and TCP/UDP Port tester.
See complete example here: docker-with-services
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
For a complete sample, see docker-with-services.
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.