Skip to content

docs: add Windows troubleshooting guide for libmagic and MySQL #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Laks-D wants to merge 4 commits into
base: master
Choose a base branch
from
Open

docs: add Windows troubleshooting guide for libmagic and MySQL #1025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc5c555
docs: add Windows troubleshooting guide for libmagic and MySQL
Laks-D Feb 19, 2026
4a97e99
docs: add understated Windows setup note to installation guide
Laks-D Feb 19, 2026
1c3010e
docs: refine formatting of Windows environment note
Laks-D Feb 19, 2026
a7ee17a
Merge branch 'master' into master
Laks-D Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ samples and associated test results.
An installation guideline can be found here:
[installation guide](install/installation.md).

### Windows Setup Troubleshooting

If you are setting up the platform on Windows, you may encounter environment-specific blockers. Use the following fixes to stabilize your build:

#### 1. libmagic ImportError
The `python-magic` library requires native C-dependencies. On Windows, the standard package often fails to locate `magic.dll`.
* **Fix:**
```powershell
pip uninstall python-magic
pip install python-magic-bin
```
#### 2. MySQL Driver Configuration
To ensure `SQLAlchemy` communicates correctly with a local MySQL instance on Windows, use the `pymysql` driver dialect in your `config.py`.
* **Fix:** Update your `DATABASE_URI` string as follows:
`DATABASE_URI = 'mysql+pymysql://user:password@localhost/db_name'`

#### 3. Environment Variables (PowerShell)
The `flask db` commands require the `FLASK_APP` variable to be set. In PowerShell, the standard `export` command will not work.
* **Fix:**
```powershell
$env:FLASK_APP = "run.py"
```

## Sample Updates

A lot of times it may happen that we add new features to ccextractor which render the result files associated with
Expand Down
4 changes: 4 additions & 0 deletions install/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
* MySQL
* Pure-FTPD with mysql (optional, only needed for FTP file uploads)

## Note for Windows Environments

Developing on Windows requires the `python-magic-bin` package and the `pymysql` driver for SQLAlchemy. Detailed steps for resolving these specific environment blockers, including PowerShell variable syntax, are documented in the [Windows Setup Troubleshooting](../README.md#windows-setup-troubleshooting) section of the main README.

## Configuring Google Cloud Platform

To configure the GCP for the platform, see [the installation guide](ci-vm/installation.md).
Expand Down