https://github.com/friendsofshopware/shopmon
Shopware Shop Monitoring
https://github.com/friendsofshopware/shopmon
Last synced: 4 months ago
JSON representation
Shopware Shop Monitoring
- Host: GitHub
- URL: https://github.com/friendsofshopware/shopmon
- Owner: FriendsOfShopware
- License: mit
- Created: 2022-08-24T16:24:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-28T05:48:17.000Z (4 months ago)
- Last Synced: 2026-03-28T10:50:57.928Z (4 months ago)
- Language: Vue
- Homepage:
- Size: 7.3 MB
- Stars: 62
- Watchers: 4
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Shop Monitoring
Shopmon is an application from FriendsOfShopware to manage multiple Shopware instances.
- Credentials are saved in a SQLite database
- Client secrets are encrypted using [web crypto api](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) outside the database
- API runs on Bun runtime
- Mails are sent via SMTP
## Features
Overview of all your Shopware instances to see:
- Shopware Version and Security Updates
- Show all installed extension and extension updates
- Show info on scheduled tasks and queue
- Run a daily check with sitespeed to see decreasing performance
- Clear shop cache
## Requirements (self hosted)
> [!NOTE]
> It's not recommended to self-host this application, we don't give any support for self-hosted installations. Please use the managed version at https://shopmon.fos.gg
- Bun runtime (v1.0 or higher)
- SQLite 3
- Node.js 20+ and PNPM (for building frontend)
## Managed / SaaS
https://shopmon.fos.gg
## Local Installation
### Prerequisites
- Bun
- Node.js 22 or higher
### Step 1: Clone the repository
```bash
git clone https://github.com/FriendsOfShopware/shopmon.git
cd shopmon
```
### Step 2: Install dependencies
```bash
make setup
```
This will install dependencies for both the API and frontend.
### Step 3: Configure environment
Copy the example environment file and configure it:
```bash
cp api/.env.example api/.env
```
Edit `api/.env` with your configuration:
```env
# Database
# Security (generate a secure random string)
APP_SECRET=your-secure-random-string-here
# Email configuration
SMTP_SERVER=smtp.example.com
SMTP_PORT=587
SMTP_USER=your-email@example.com
SMTP_PASS=your-password
SMTP_FROM=noreply@yourdomain.com
# Application
FRONTEND_URL=http://localhost:3000
APP_FILES_DIR=./files
# Monitoring (optional)
SENTRY_DSN=
```
### Step 4: Run database migrations
```bash
make migrate
```
### Step 5: Start the application
For development:
```bash
make dev
```
This will start:
- API server on http://localhost:5789 (proxied by the frontend, not accessed directly)
- Frontend dev server on http://localhost:3000 (open this in your browser)
### Additional services
To develop Shopmon easier, you can start a local mail catcher and a local Shopware installation with:
```
make up
```
### Endpoints:
| Application | Link | Info |
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------------- |
| Shopmon Frontend | http://localhost:3000 | |
| Shopmon API | http://localhost:5789 | Accessed via proxy |
| Mailpit | http://localhost:8025 | For mails |
| Demo Shop Frontend | http://localhost:3889 | |
| Demo Shop Admin | http://localhost:3889/admin | Username: `admin`, Password: `shopware` |
| Demo Shop Api | http://localhost:3889/api | Client Id: `SWIAUZL4OXRKEG1RR3PMCEVNMG`, Client Secret: `aXhNQ3NoRHZONmxPYktHT0c2c09rNkR0UHI0elZHOFIycjBzWks` |
## Configuration
### Production Deployment
For production deployment, you can use the provided Docker setup:
1. Build the Docker image:
```bash
docker build -t shopmon .
```
2. Run with docker compose:
```bash
docker compose -f compose.deploy.yml up -d
```
Make sure to:
- Use a strong APP_SECRET
- Configure proper email settings
- Set up persistent volumes for database and uploads
- Configure a reverse proxy (nginx, traefik, etc.) for HTTPS
## Contributing
We welcome contributions! Please see our [Contributing Guidelines](./CONTRIBUTING.md) for details on how to get started.
## License
MIT