venus/aperisolve
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add github markdown alerts

Browse Source
This commit is contained in:
Zeecka
2025-12-28 17:25:05 +01:00
parent b096d13344
commit a2987ed90b
1 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -16
View File
@@ -20,7 +20,6 @@ Support Aperi'Solve:
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="40" /> <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="40" />
</a> </a>
--- ---
Aperi'Solve is an open-source steganalysis web platform that performs automated analysis on images to detect and extract hidden data using common steganography tools and techniques. Aperi'Solve is an open-source steganalysis web platform that performs automated analysis on images to detect and extract hidden data using common steganography tools and techniques.
@@ -87,10 +86,12 @@ docker exec -it aperisolve-web bash
docker exec -it postgres psql -U aperiuser -d aperisolve docker exec -it postgres psql -U aperiuser -d aperisolve
``` ```
Note: If switching between dev and production compose files, remove the `results` directory or mounted volume to avoid conflicts: > [!WARNING]
```bash > If switching between dev and production compose files, remove the `results` directory or mounted volume to avoid conflicts:
rm -rf aperisolve/results > ```bash
``` > rm -rf aperisolve/results
> ```
### Adding a new analyzer ### Adding a new analyzer
Adding a custom analyzer is straightforward: Adding a custom analyzer is straightforward:
@@ -129,9 +130,9 @@ Adding a custom analyzer is straightforward:
4. Test locally: run the worker and submit jobs to ensure outputs are produced and displayed. 4. Test locally: run the worker and submit jobs to ensure outputs are produced and displayed.
Tips: > [!TIP]
- Keep analyzers idempotent and write outputs to the provided `results_dir`. > - Keep analyzers idempotent and write outputs to the provided `results_dir`.
- Return structured JSON so the frontend can render links/downloads automatically. > - Return structured JSON so the frontend can render links/downloads automatically.
## Configuration & environment variables ## Configuration & environment variables
@@ -147,7 +148,8 @@ Main environment variables (examples):
- SECRET_KEY=change_me - SECRET_KEY=change_me
- FLASK_ENV=production/development - FLASK_ENV=production/development
If using Docker Compose, defaults are set in the compose files. For production deployments, set secure secrets via your orchestrator or environment. > [!NOTE]
> If using Docker Compose, defaults are set in the compose files. For production deployments, set secure secrets via your orchestrator or environment.
## Architecture ## Architecture
@@ -182,18 +184,19 @@ Contributions are welcome! Please:
2. Create a feature branch 2. Create a feature branch
3. Open a pull request describing your change 3. Open a pull request describing your change
Please follow the code style and run linters before submitting. > [!IMPORTANT]
The project adheres to: > Please follow the code style and run linters before submitting. The project adheres to:
- Black > - Black
- Flake8 (ignoring E203, E501, W503) > - Flake8 (ignoring E203, E501, W503)
- Pylint (ignoring W0718, R0903, R0801) > - Pylint (ignoring W0718, R0903, R0801)
- Mypy (ignoring unused-awaitable) > - Mypy (ignoring unused-awaitable)
CI will run these checks on each PR. CI will run these checks on each PR.
## Security ## Security
- If you discover a security issue, please report it privately to the repository owner instead of opening a public issue. > [!WARNING]
> If you discover a security issue, please report it privately to the repository owner instead of opening a public issue.
## Credits ## Credits