mirror of
https://github.com/sharevb/it-tools.git
synced 2026-11-20 21:23:08 +03:00
309 lines
11 KiB
Markdown
309 lines
11 KiB
Markdown
## BREAKING CHANGE for Docker Image
|
|
|
|
Since *Docker base image* is now `nginx-unpriviledged`, docker image now listen to **8080** and no more 80. So you need to update your port mapping, ie from `8080:80` to `8080:8080`.
|
|
|
|
### Check out these change here: <https://sharevb-it-tools.vercel.app/>
|
|
|
|
You can use my image in your docker-compose file if you want an update 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](https://github.com/sharevb/it-tools/pkgs/container/it-tools)
|
|
|
|
(Thanks to [gitmotion](https://github.com/gitmotion/it-tools) for this model of README fork)
|
|
|
|
## Added features
|
|
|
|
Almost [all tools PR of it-tools](https://github.com/sharevb/it-tools/pulls).
|
|
|
|
## Docker images
|
|
|
|
[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest`
|
|
|
|
[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest`
|
|
|
|
## Use in Docker Compose file
|
|
|
|
```yml
|
|
services:
|
|
it-tools:
|
|
container_name: it-tools
|
|
image: sharevb/it-tools:latest
|
|
pull_policy: always
|
|
restart: unless-stopped
|
|
ports:
|
|
- 8080:8080
|
|
```
|
|
|
|
## 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:
|
|
```json
|
|
{
|
|
"excludeCategoryFilterRegex": "",
|
|
"includeCategoryFilterRegex": "",
|
|
"excludeToolsFilterRegex": "",
|
|
"includeToolsFilterRegex": ""
|
|
}
|
|
```
|
|
Category matches on category (English) names ; Tools matches on tools path/url.
|
|
|
|
See (docker-tools-filter-and-home-content)[https://github.com/sharevb/it-tools]
|
|
|
|
## 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 docker 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](https://nginxproxymanager.com/), [Traefik](https://traefik.io/traefik/), [caddy](https://caddyserver.com/) 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](https://github.com/sharevb/it-tools/docker-subfolder-sample), this docker image needs to have another reverse proxy in front of it, like [Nginx Proxy Manager](https://nginxproxymanager.com/), [Traefik](https://traefik.io/traefik/), [caddy](https://caddyserver.com/) etc.
|
|
|
|
Setup a reverse proxy pass using `/it-tools/`. And you should be able to access it-tools in `/it-tools/` of your server.
|
|
|
|
To run the sample:
|
|
|
|
```bash
|
|
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:
|
|
|
|
1. `BASE_URL="/it-tools/" pnpm build`
|
|
2. Rename the generated `dist` folder to `it-tools` and serve on `https://your-domain.com/it-tools`
|
|
|
|
## To build for GitHub Pages:
|
|
|
|
1. Enable GitHub Pages build and deployment option in your fork, under **Settings** > **Pages** and select **GitHub Actions** as the source
|
|
2. Add the following GitHub action to your repo:
|
|
|
|
.github/workflows/deploy-pages.yaml
|
|
```yaml
|
|
name: Deploy static content to Pages
|
|
|
|
on:
|
|
# Runs on pushes targeting the default branch
|
|
push:
|
|
branches: ["main"]
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
|
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
# Single deploy job since we're just deploying
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
|
|
- name: Install Node.js
|
|
uses: actions/setup-node@v3
|
|
with:
|
|
node-version: 18
|
|
|
|
- uses: pnpm/action-setup@v2
|
|
name: Install pnpm
|
|
id: pnpm-install
|
|
with:
|
|
version: 8
|
|
run_install: true
|
|
|
|
- name: Build
|
|
run: |
|
|
BASE_URL="/it-tools/" pnpm build
|
|
cp dist/index.html dist/404.html
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v3
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v1
|
|
with:
|
|
path: './dist'
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v2
|
|
```
|
|
|
|
## Installation methods
|
|
|
|
Local installation required installing first: `python3 make g++`
|
|
|
|
| Docker Image | Local Installation |
|
|
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
|
|
| GitHub Container Registry: <span title="triple click me!">`ghcr.io/sharevb/it-tools:latest`</span><br/>Docker Hub: <span title="triple click me!">`sharevb/it-tools:latest`</span> | <span title="triple click me!">`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 && pnpm dev`</span> |
|
|
| 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 |
|
|
|
|
<picture>
|
|
<source srcset="./.github/logo-dark.png" media="(prefers-color-scheme: light)">
|
|
<source srcset="./.github/logo-white.png" media="(prefers-color-scheme: dark)">
|
|
<img src="./.github/logo-dark.png" alt="logo">
|
|
</picture>
|
|
|
|
<details>
|
|
|
|
Useful tools for developer and people working in IT. [Have a look !](https://sharevb-it-tools.vercel.app).
|
|
|
|
## Functionalities and roadmap
|
|
|
|
Please check the [issues](https://github.com/sharevb/it-tools/issues) to see if some feature listed to be implemented.
|
|
|
|
You have an idea of a tool? Submit a [feature request](https://github.com/sharevb/it-tools/issues/new/choose)!
|
|
|
|
## Self host
|
|
|
|
Self host solutions for your homelab
|
|
|
|
**From docker hub:**
|
|
|
|
```sh
|
|
docker run -d --name it-tools --restart unless-stopped -p 8080:8080 corentinth/it-tools:latest
|
|
```
|
|
|
|
**From github packages:**
|
|
|
|
```sh
|
|
docker run -d --name it-tools --restart unless-stopped -p 8080:8080 ghcr.io/corentinth/it-tools:latest
|
|
```
|
|
|
|
**Other solutions:**
|
|
|
|
- [Cloudron](https://www.cloudron.io/store/tech.ittools.cloudron.html)
|
|
- [Tipi](https://www.runtipi.io/docs/apps-available)
|
|
- [Unraid](https://unraid.net/community/apps?q=it-tools)
|
|
|
|
## Contribute
|
|
|
|
### Recommended IDE Setup
|
|
|
|
[VSCode](https://code.visualstudio.com/) with the following extensions:
|
|
|
|
- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur)
|
|
- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
|
|
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally)
|
|
|
|
with the following settings:
|
|
|
|
```json
|
|
{
|
|
"editor.formatOnSave": false,
|
|
"editor.codeActionsOnSave": {
|
|
"source.fixAll.eslint": true
|
|
},
|
|
"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)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) 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](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
|
|
|
|
1. Disable the built-in TypeScript Extension
|
|
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
|
|
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
|
|
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
|
|
|
|
### Project Setup
|
|
|
|
```sh
|
|
pnpm install
|
|
```
|
|
|
|
### Compile and Hot-Reload for Development
|
|
|
|
```sh
|
|
pnpm dev
|
|
```
|
|
|
|
### Type-Check, Compile and Minify for Production
|
|
|
|
```sh
|
|
pnpm build
|
|
```
|
|
|
|
### Run Unit Tests with [Vitest](https://vitest.dev/)
|
|
|
|
```sh
|
|
pnpm test
|
|
```
|
|
|
|
### Lint with [ESLint](https://eslint.org/)
|
|
|
|
```sh
|
|
pnpm lint
|
|
```
|
|
|
|
### Create a new tool
|
|
|
|
To create a new tool, there is a script that generate the boilerplate of the new tool, simply run:
|
|
|
|
```sh
|
|
pnpm run script:create:tool my-tool-name
|
|
```
|
|
|
|
It will create a directory in `src/tools` with the correct files, and a the import in `src/tools/index.ts`. You will just need to add the imported tool in the proper category and develop the tool.
|
|
|
|
## Contributors
|
|
|
|
Big thanks to all the people who have already contributed!
|
|
|
|
[](https://github.com/sharevb/it-tools/graphs/contributors)
|
|
|
|
## Credits
|
|
|
|
Coded with ❤️ by [Corentin Thomasset](https://corentin.tech?utm_source=it-tools&utm_medium=readme).
|
|
|
|
This project is continuously deployed using [vercel.com](https://vercel.com).
|
|
|
|
Contributor graph is generated using [contrib.rocks](https://contrib.rocks/preview?repo=corentinth/it-tools).
|
|
|
|
<a href="https://www.producthunt.com/posts/it-tools?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-it-tools" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=345793&theme=light" alt="IT Tools - Collection of handy online tools for devs, with great UX | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
|
<a href="https://www.producthunt.com/posts/it-tools?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-it-tools" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=345793&theme=light&period=daily" alt="IT Tools - Collection of handy online tools for devs, with great UX | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
|
|
|
## License
|
|
|
|
This project is under the [GNU GPLv3](LICENSE).
|
|
|
|
</details> |