https://github.com/altinn/digdir-chunker
https://github.com/altinn/digdir-chunker
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/altinn/digdir-chunker
- Owner: Altinn
- License: mit
- Created: 2025-04-10T15:57:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-06T16:12:57.000Z (11 months ago)
- Last Synced: 2025-08-06T18:15:55.089Z (11 months ago)
- Language: PHP
- Size: 210 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# digdir-chunker
This application provides a JSON REST API and MCP tools for converting PDF and other documents to paginated and chunked Markdown.
The service takes a URL to a document as input and returns a document ID which can be used as a parameter for polling the conversion status and retrieving the converted and chunked document when it has been processed.
## Development and deployment
Create an environment file and make any eventual configuration changes (e.g. change `APP_ENV` from `local` to `production` for deployment).
```
cp .env.example .env
```
Start the application and required services:
```
docker-compose up -d
```
Install dependencies:
```
docker compose exec app composer install
```
Set the application key:
```
docker compose exec app php artisan key:generate
```
Run database migrations:
```
docker compose exec app php artisan migrate
```
Restart queues:
```
docker compose exec app php artisan queue:restart
```
The application should now be up and running on localhost port 80 by default.
## MCP setup
The HTTP transport MCP server is available at http://localhost/mcp by default.
The MCP server can also be run locally using the stdio transport. Replace `` with the absolute path to this repo in this example config:
```
{
"mcpServers": {
"digdir-chunker": {
"command": "/usr/local/bin/docker",
"args": [
"compose",
"-f",
"/docker-compose.yml",
"exec",
"-T",
"app",
"php",
"artisan",
"mcp:serve",
"--transport=stdio"
]
}
}
}
```
## Common commands
Restart the queue (required after code changes that affect jobs)
```
docker compose exec app php artisan queue:restart
```
Reset the database (delete tables, run migrations and seed the database with default data)
```
docker compose exec app php artisan migrate:refresh --seed
```
List all available commands:
```
docker compose exec app php artisan list
```
## REST API documentation
API documentation is automatically generated and published at `/docs/api`.
## Maintenance
Dependencies should be regularly updated by running:
```
composer update
yarn upgrade
```
and committing changes in `composer.json` and `yarn.json`.
## Tech stack
- PHP (php-fpm)
- Laravel framework
- MariaDB
- Nginx
- [Marker](https://github.com/VikParuchuri/marker)