Description | Installation | Website | Modules | Issues | Supporting
Project iKy is a tool that collects information from an email and shows results in a nice visual interface.
Visit the Gitlab Page of the Project
- Docker
- Docker Compose (included with Docker Desktop)
- (Optional) just task runner
git clone https://gitlab.com/kennbroorg/iKy.git
cd iKy
docker compose build
docker compose up -dOr, if you have just installed:
just build
just upOpen your browser at http://localhost:4200
To stop all services:
docker compose down
# or
just downThe development workflow uses a virtualenv for linting/pre-commit hooks and Docker for building and running the application.
Install just, then:
just setup
source .venv/bin/activateThis creates a Python virtualenv with pre-commit and ruff, and installs the git hooks.
| Command | Description |
|---|---|
just build |
Build Docker images |
just up |
Start all services |
just down |
Stop all services |
just logs |
Follow backend logs (just logs frontend for frontend) |
just ps |
Show running containers |
just shell-backend |
Open a shell in the backend container |
just shell-frontend |
Open a shell in the frontend container |
just lint |
Run ruff linter and format check |
just fmt |
Auto-format Python code |
just restart backend |
Restart a specific service |
just rebuild |
Stop, rebuild, and start all services |
just clean |
Remove containers, volumes, and local images |
Once the application is loaded in the browser, it should get most of the APIs and/or session cookies from the browser. Below is a table with all the fields to fill out
| Module | Status | Field in apikey | Description |
|---|---|---|---|
| Fullcontact | :octagonal_sign: | Discontinued | |
| PeopleDataLabs | 🆗 | peopledatalabs_key | 🆓 API Free. Explained here |
| 🆗 | linkedin_li_at / linkedin_JSESSIONID (***) | 🆓 Cookie browser(🍪) method. Explained here | |
| 🆗 | twitter_user / twitter_pass (***) | 🆓 Cookie browser(🍪) or user/pass. Explained here | |
| 🆗 | instagram_user / instagram_pass (***) | 🆓 Cookie browser(🍪) or user/pass. Explained here | |
| HaveIBeenPwned | 🆗 | haveibeenpwned_key | 💲 API Paid. Explained here |
| Emailrep | 🆗 | emailrep_key | 🆓 API Free. Explained here |
| Leaklookup | 🆗 | leaklookup_key | 🆓 API Free. Explained here |
| Spotify | 🆗 | spotify_client_id / spotify_client_secret | 🆓 API Free. Explained here |
| Twitch | 🆗 | twitch_client_id / twitch_client_secret | 🆓 API Free. Explained here |
| CSE (Google) | 🆗 | cse_api_key / cse_cx | 🆓 API Free. Explained here |
| In revision | |||
| Tiktok | 🆗 | Get from your preferred browser. Just log in with your user |
Pull the latest changes and rebuild the Docker images:
git pull
docker compose build
docker compose up -dOr with just:
git pull
just rebuildTo preserve your API keys across updates, use the Export/Import options in the apikeys menu of the graphical interface.
Vimeo
Anyone who contributes or contributed to the project, including me, is not responsible for the use of the tool (Neither the legal use nor the illegal use, nor the "other" use).
Keep in mind that this software was initially written for a joke, then for educational purposes (to educate ourselves), and now the goal is to collaborate with the community making quality free software, and while the quality is not excellent (sometimes not even good) we strive to pursue excellence.
Consider that all the information collected is free and available online, the tool only tries to discover, collect and display it. Many times the tool cannot even achieve its goal of discovery and collection. Please load the necessary APIs before remembering my mother. If even with the APIs it doesn't show "nice" things that you expect to see, try other e-mails before you remember my mother. If you still do not see the "nice" things you expect to see, you can create an issue, contact us by e-mail or by any of the RRSS, but keep in mind that my mother is neither the creator nor Contribute to the project.
We do not refund your money if you are not satisfied. I hope you enjoy using the tool as much as we enjoy doing it. The effort was and is enormous (Time, knowledge, coding, tests, reviews, etc.) but we would do it again. Do not use the tool if you cannot read the instructions and / or this disclaimer clearly.
By the way, for those who insist on remembering my mother, she died many years ago but I love her as if she were right here.
