{"id":50434876,"url":"https://github.com/nakamura196/omeka-s-docker","last_synced_at":"2026-05-31T16:32:13.747Z","repository":{"id":307212287,"uuid":"752919053","full_name":"nakamura196/omeka-s-docker","owner":"nakamura196","description":"🐳 Production-ready Docker setup for Omeka S with IIIF support, automatic SSL, and modern development tools","archived":false,"fork":false,"pushed_at":"2025-07-30T01:31:26.000Z","size":35,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-30T03:52:37.626Z","etag":null,"topics":["digital-humanities","docker","docker-compose","glam","iiif","omeka-s","traefik"],"latest_commit_sha":null,"homepage":"https://github.com/nakamura196/omeka-s-docker","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nakamura196.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-05T05:20:46.000Z","updated_at":"2025-07-30T01:31:30.000Z","dependencies_parsed_at":"2025-07-30T03:52:39.065Z","dependency_job_id":"e712f7fa-0e65-441c-b02a-d58ea507e8ed","html_url":"https://github.com/nakamura196/omeka-s-docker","commit_stats":null,"previous_names":["nakamura196/omeka-s-docker"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/nakamura196/omeka-s-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nakamura196%2Fomeka-s-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nakamura196%2Fomeka-s-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nakamura196%2Fomeka-s-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nakamura196%2Fomeka-s-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nakamura196","download_url":"https://codeload.github.com/nakamura196/omeka-s-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nakamura196%2Fomeka-s-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33739861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-humanities","docker","docker-compose","glam","iiif","omeka-s","traefik"],"created_at":"2026-05-31T16:32:09.325Z","updated_at":"2026-05-31T16:32:13.728Z","avatar_url":"https://github.com/nakamura196.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Omeka S Docker\n\n🐳 A modern Docker setup for [Omeka S](https://omeka.org/s/) with IIIF support, SSL/TLS encryption, and development tools.\n\n## ✨ Features\n\n- **Modern Stack**: PHP 8.1, Apache, MariaDB\n- **IIIF Support**: Pre-configured IIIF Server, Image Server, and Universal Viewer modules\n- **SSL/TLS**: Automatic HTTPS with Let's Encrypt via Traefik\n- **Development Tools**: \n  - Mailpit for email testing\n  - phpMyAdmin for database management\n  - Hot-reload for modules and themes\n- **Production Ready**: Optimized for production deployment\n- **Security**: Environment-based configuration with secure defaults\n\n## 🚀 Quick Start\n\n### Prerequisites\n\n- Docker and Docker Compose installed\n- Domain name (for production with SSL)\n\n### Development Setup\n\n1. **Clone and setup environment**\n```bash\ngit clone https://github.com/nakamura196/omeka-s-docker.git\ncd omeka-s-docker\ncp .env.example .env\ncp config/local.config.php.example config/local.config.php\n```\n\n2. **Configure environment variables**\n```bash\nnano .env  # Edit with your settings\n```\n\n3. **Start services**\n```bash\ndocker compose up -d\n```\n\n4. **Access services**\n- Omeka S: http://localhost\n- phpMyAdmin: http://localhost:8080\n- Mailpit: http://localhost:8025\n\n### Production Setup with SSL\n\n1. **Setup environment for production**\n```bash\ncp .env.omeka.example .env.omeka\nnano .env.omeka  # Configure your domain and credentials\n```\n\n2. **Run setup script**\n```bash\n./setup-omeka-traefik.sh\n```\n\n3. **Install modules and themes**\n```bash\n./install-modules.sh\n```\n\n## 📦 Services\n\n| Service | Description | Port | URL |\n|---------|-------------|------|-----|\n| **Omeka S** | Main application | 80/443 | http://localhost or https://yourdomain.com |\n| **MariaDB** | Database | 3306 | Internal only |\n| **phpMyAdmin** | Database management | 8080 | http://localhost:8080 |\n| **Mailpit** | Email testing | 8025 | http://localhost:8025 |\n| **Traefik** | Reverse proxy \u0026 SSL | 8090 | http://localhost:8090 (dashboard) |\n\n## 🔧 Configuration\n\n### Environment Variables\n\n#### Development (.env)\n```env\n# Database\nMYSQL_ROOT_PASSWORD=your_secure_root_password\nMYSQL_DATABASE=omeka\nMYSQL_USER=omeka\nMYSQL_PASSWORD=your_secure_password\n\n# Omeka\nOMEKA_VERSION=4.1.1\n\n# PHP Settings\nPHP_MEMORY_LIMIT=256M\nPHP_UPLOAD_MAX_FILESIZE=100M\nPHP_POST_MAX_SIZE=100M\n\n# Mail (leave empty for Mailpit)\nSENDGRID_API_KEY=\nMAIL_FROM_ADDRESS=noreply@localhost\nMAIL_FROM_NAME=Omeka S\n```\n\n#### Production (.env.omeka)\n```env\n# Domain Configuration\nDOMAIN=yourdomain.com\nACME_EMAIL=admin@yourdomain.com\n\n# Database (use strong passwords)\nMYSQL_ROOT_PASSWORD=very_secure_root_password\nMYSQL_DATABASE=omeka_production\nMYSQL_USER=omeka_user\nMYSQL_PASSWORD=very_secure_password\n\n# SendGrid for production email\nSENDGRID_API_KEY=SG.your_actual_api_key_here\nMAIL_FROM_ADDRESS=noreply@yourdomain.com\nMAIL_FROM_NAME=Your Omeka Site\n```\n\n## 📚 Modules \u0026 Themes\n\n### Included Modules\n- **Common**: Base module for other extensions\n- **IiifServer**: IIIF Image and Presentation API server\n- **ImageServer**: Image processing and serving\n- **UniversalViewer**: IIIF-compliant viewer\n\n### Module Management\n\n**Install/Update modules:**\n```bash\n./install-modules.sh\n```\n\n**Check for updates:**\n```bash\n./update-modules.sh\n```\n\n**Manual installation:**\n```bash\ncd modules\nwget https://github.com/author/module/releases/download/version/module.zip\nunzip module.zip \u0026\u0026 rm module.zip\n```\n\n## 🛠️ Management Commands\n\n### Container Management\n```bash\n# Start services\ndocker compose up -d\n\n# Stop services\ndocker compose down\n\n# View logs\ndocker compose logs -f\n\n# Restart specific service\ndocker compose restart omeka\n\n# Shell access\ndocker compose exec omeka bash\n```\n\n### Database Operations\n```bash\n# Database backup\ndocker compose exec mariadb mysqldump -u root -p omeka \u003e backup.sql\n\n# Database restore\ndocker compose exec -i mariadb mysql -u root -p omeka \u003c backup.sql\n\n# Access MySQL CLI\ndocker compose exec mariadb mysql -u root -p\n```\n\n### SSL/Production Management\n```bash\n# Production setup\n./setup-omeka-traefik.sh\n\n# Check SSL certificates\ndocker compose -f docker-compose-omeka-traefik.yml logs traefik\n\n# View Traefik dashboard\n# https://traefik.yourdomain.com (or http://localhost:8090)\n```\n\n## 🔒 Security\n\n### Best Practices\n- ✅ Use strong, unique passwords for all services\n- ✅ Keep environment files (`.env*`) out of version control\n- ✅ Use HTTPS in production\n- ✅ Regularly update Docker images and modules\n- ✅ Limit SendGrid API key permissions to `mail.send` only\n- ✅ Use firewall rules to restrict database access\n\n### Security Headers\nThe Traefik configuration includes security headers:\n- HSTS (HTTP Strict Transport Security)\n- X-Frame-Options: DENY\n- X-Content-Type-Options: nosniff\n- Referrer Policy: strict-origin-when-cross-origin\n\n## 📁 Directory Structure\n\n```\nomeka-s-docker/\n├── docker-compose.yml              # Development setup\n├── docker-compose-omeka-traefik.yml # Production setup with SSL\n├── Dockerfile                      # Omeka S image definition\n├── .env.example                   # Development environment template\n├── .env.omeka.example            # Production environment template\n├── install-modules.sh            # Module installation script\n├── update-modules.sh             # Module update checker\n├── setup-omeka-traefik.sh       # Production setup script\n├── config/\n│   └── local.config.php.example  # Omeka S configuration template\n├── modules/                      # Omeka S modules\n├── themes/                       # Omeka S themes\n└── traefik/\n    └── letsencrypt/             # SSL certificates\n```\n\n## 🔍 Troubleshooting\n\n### Common Issues\n\n**Container won't start:**\n```bash\n# Check logs\ndocker compose logs service-name\n\n# Rebuild without cache\ndocker compose build --no-cache\n```\n\n**Database connection issues:**\n```bash\n# Verify database is running\ndocker compose ps\ndocker compose logs mariadb\n\n# Test connection\ndocker compose exec mariadb mysql -u root -p -e \"SHOW DATABASES;\"\n```\n\n**SSL certificate issues:**\n```bash\n# Check Traefik logs\ndocker compose -f docker-compose-omeka-traefik.yml logs traefik\n\n# Verify domain DNS\nnslookup yourdomain.com\n\n# Check certificate status\ncurl -I https://yourdomain.com\n```\n\n**Permission issues:**\n```bash\n# Fix file permissions\ndocker compose exec omeka chown -R www-data:www-data /var/www/html/\ndocker compose exec omeka chmod -R 755 /var/www/html/modules /var/www/html/themes\n```\n\n### Performance Tuning\n\n**Increase PHP limits:**\n```env\nPHP_MEMORY_LIMIT=512M\nPHP_UPLOAD_MAX_FILESIZE=200M\nPHP_POST_MAX_SIZE=200M\n```\n\n**Database optimization:**\n```bash\n# Add to .env for larger installations\nMYSQL_INNODB_BUFFER_POOL_SIZE=1G\n```\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Test thoroughly\n5. Submit a pull request\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- [Omeka S](https://omeka.org/s/) - Digital publishing platform\n- [Daniel-KM](https://github.com/Daniel-KM) - IIIF modules developer\n- [Traefik](https://traefik.io/) - Modern reverse proxy\n- [Docker](https://docker.com/) - Containerization platform\n\n## 📞 Support\n\n- **Issues**: [GitHub Issues](https://github.com/nakamura196/omeka-s-docker/issues)\n- **Discussions**: [GitHub Discussions](https://github.com/nakamura196/omeka-s-docker/discussions)\n- **Omeka S Documentation**: [https://omeka.org/s/docs/](https://omeka.org/s/docs/)\n\n---\n\n**Made with ❤️ for the digital humanities community**\n\n---\n\n# Omeka S Docker（日本語）\n\n🐳 [Omeka S](https://omeka.org/s/) のための現代的なDocker環境。IIIF対応、SSL/TLS暗号化、開発ツールを含みます。\n\n## ✨ 機能\n\n- **現代的なスタック**: PHP 8.1、Apache、MariaDB\n- **IIIF対応**: IIIF Server、Image Server、Universal Viewerモジュールを事前設定\n- **SSL/TLS**: TraefikによるLet's Encryptを使った自動HTTPS\n- **開発ツール**:\n  - メールテスト用Mailpit\n  - データベース管理用phpMyAdmin\n  - モジュールとテーマのホットリロード\n- **本番対応**: 本番デプロイメント向けに最適化\n- **セキュリティ**: 環境ベース設定とセキュアなデフォルト値\n\n## 🚀 クイックスタート\n\n### 前提条件\n\n- DockerとDocker Composeがインストール済み\n- ドメイン名（SSL付き本番環境用）\n\n### 開発環境セットアップ\n\n1. **クローンと環境設定**\n```bash\ngit clone https://github.com/nakamura196/omeka-s-docker.git\ncd omeka-s-docker\ncp .env.example .env\ncp config/local.config.php.example config/local.config.php\n```\n\n2. **環境変数の設定**\n```bash\nnano .env  # 設定値を編集\n```\n\n3. **サービス開始**\n```bash\ndocker compose up -d\n```\n\n4. **サービスへのアクセス**\n- Omeka S: http://localhost\n- phpMyAdmin: http://localhost:8080\n- Mailpit: http://localhost:8025\n\n### SSL付き本番環境セットアップ\n\n1. **本番環境用設定**\n```bash\ncp .env.omeka.example .env.omeka\nnano .env.omeka  # ドメインと認証情報を設定\n```\n\n2. **セットアップスクリプト実行**\n```bash\n./setup-omeka-traefik.sh\n```\n\n3. **モジュールとテーマのインストール**\n```bash\n./install-modules.sh\n```\n\n## 📦 サービス\n\n| サービス | 説明 | ポート | URL |\n|----------|------|-------|-----|\n| **Omeka S** | メインアプリケーション | 80/443 | http://localhost または https://yourdomain.com |\n| **MariaDB** | データベース | 3306 | 内部のみ |\n| **phpMyAdmin** | データベース管理 | 8080 | http://localhost:8080 |\n| **Mailpit** | メールテスト | 8025 | http://localhost:8025 |\n| **Traefik** | リバースプロキシ \u0026 SSL | 8090 | http://localhost:8090 (ダッシュボード) |\n\n## 🔧 設定\n\n### 環境変数\n\n#### 開発環境 (.env)\n```env\n# データベース\nMYSQL_ROOT_PASSWORD=安全なルートパスワード\nMYSQL_DATABASE=omeka\nMYSQL_USER=omeka\nMYSQL_PASSWORD=安全なパスワード\n\n# Omeka\nOMEKA_VERSION=4.1.1\n\n# PHP設定\nPHP_MEMORY_LIMIT=256M\nPHP_UPLOAD_MAX_FILESIZE=100M\nPHP_POST_MAX_SIZE=100M\n\n# メール（Mailpit使用時は空のまま）\nSENDGRID_API_KEY=\nMAIL_FROM_ADDRESS=noreply@localhost\nMAIL_FROM_NAME=Omeka S\n```\n\n#### 本番環境 (.env.omeka)\n```env\n# ドメイン設定\nDOMAIN=yourdomain.com\nACME_EMAIL=admin@yourdomain.com\n\n# データベース（強力なパスワードを使用）\nMYSQL_ROOT_PASSWORD=非常に安全なルートパスワード\nMYSQL_DATABASE=omeka_production\nMYSQL_USER=omeka_user\nMYSQL_PASSWORD=非常に安全なパスワード\n\n# 本番環境用SendGrid\nSENDGRID_API_KEY=SG.実際のAPIキー\nMAIL_FROM_ADDRESS=noreply@yourdomain.com\nMAIL_FROM_NAME=あなたのOmekaサイト\n```\n\n## 📚 モジュール \u0026 テーマ\n\n### 含まれるモジュール\n- **Common**: 他の拡張機能のベースモジュール\n- **IiifServer**: IIIF画像とプレゼンテーションAPIサーバー\n- **ImageServer**: 画像処理と配信\n- **UniversalViewer**: IIIF準拠ビューアー\n\n### モジュール管理\n\n**モジュールのインストール/更新:**\n```bash\n./install-modules.sh\n```\n\n**更新確認:**\n```bash\n./update-modules.sh\n```\n\n**手動インストール:**\n```bash\ncd modules\nwget https://github.com/作者/モジュール/releases/download/バージョン/モジュール.zip\nunzip モジュール.zip \u0026\u0026 rm モジュール.zip\n```\n\n## 🛠️ 管理コマンド\n\n### コンテナ管理\n```bash\n# サービス開始\ndocker compose up -d\n\n# サービス停止\ndocker compose down\n\n# ログ確認\ndocker compose logs -f\n\n# 特定サービスの再起動\ndocker compose restart omeka\n\n# シェルアクセス\ndocker compose exec omeka bash\n```\n\n### データベース操作\n```bash\n# データベースバックアップ\ndocker compose exec mariadb mysqldump -u root -p omeka \u003e backup.sql\n\n# データベース復元\ndocker compose exec -i mariadb mysql -u root -p omeka \u003c backup.sql\n\n# MySQL CLI アクセス\ndocker compose exec mariadb mysql -u root -p\n```\n\n### SSL/本番環境管理\n```bash\n# 本番環境セットアップ\n./setup-omeka-traefik.sh\n\n# SSL証明書確認\ndocker compose -f docker-compose-omeka-traefik.yml logs traefik\n\n# Traefikダッシュボード確認\n# https://traefik.yourdomain.com（または http://localhost:8090）\n```\n\n## 🔒 セキュリティ\n\n### ベストプラクティス\n- ✅ 全サービスに強力でユニークなパスワードを使用\n- ✅ 環境ファイル（`.env*`）をバージョン管理から除外\n- ✅ 本番環境でHTTPSを使用\n- ✅ Dockerイメージとモジュールを定期的に更新\n- ✅ SendGrid APIキーの権限を`mail.send`のみに制限\n- ✅ ファイアウォールルールでデータベースアクセスを制限\n\n### セキュリティヘッダー\nTraefik設定にはセキュリティヘッダーが含まれます：\n- HSTS（HTTP Strict Transport Security）\n- X-Frame-Options: DENY\n- X-Content-Type-Options: nosniff\n- Referrer Policy: strict-origin-when-cross-origin\n\n## 📁 ディレクトリ構造\n\n```\nomeka-s-docker/\n├── docker-compose.yml              # 開発環境設定\n├── docker-compose-omeka-traefik.yml # SSL付き本番環境設定\n├── Dockerfile                      # Omeka Sイメージ定義\n├── .env.example                   # 開発環境テンプレート\n├── .env.omeka.example            # 本番環境テンプレート\n├── install-modules.sh            # モジュールインストールスクリプト\n├── update-modules.sh             # モジュール更新チェッカー\n├── setup-omeka-traefik.sh       # 本番環境セットアップスクリプト\n├── config/\n│   └── local.config.php          # Omeka S設定\n├── modules/                      # Omeka Sモジュール\n├── themes/                       # Omeka Sテーマ\n└── traefik/\n    └── letsencrypt/             # SSL証明書\n```\n\n## 🔍 トラブルシューティング\n\n### よくある問題\n\n**コンテナが起動しない:**\n```bash\n# ログ確認\ndocker compose logs サービス名\n\n# キャッシュなしで再ビルド\ndocker compose build --no-cache\n```\n\n**データベース接続エラー:**\n```bash\n# データベースの動作確認\ndocker compose ps\ndocker compose logs mariadb\n\n# 接続テスト\ndocker compose exec mariadb mysql -u root -p -e \"SHOW DATABASES;\"\n```\n\n**SSL証明書の問題:**\n```bash\n# Traefikログ確認\ndocker compose -f docker-compose-omeka-traefik.yml logs traefik\n\n# ドメインDNS確認\nnslookup yourdomain.com\n\n# 証明書ステータス確認\ncurl -I https://yourdomain.com\n```\n\n**権限の問題:**\n```bash\n# ファイル権限修正\ndocker compose exec omeka chown -R www-data:www-data /var/www/html/\ndocker compose exec omeka chmod -R 755 /var/www/html/modules /var/www/html/themes\n```\n\n### パフォーマンスチューニング\n\n**PHP制限の増加:**\n```env\nPHP_MEMORY_LIMIT=512M\nPHP_UPLOAD_MAX_FILESIZE=200M\nPHP_POST_MAX_SIZE=200M\n```\n\n**データベース最適化:**\n```bash\n# 大規模インストールの場合は.envに追加\nMYSQL_INNODB_BUFFER_POOL_SIZE=1G\n```\n\n## 🤝 コントリビューション\n\n1. リポジトリをフォーク\n2. フィーチャーブランチを作成\n3. 変更を実装\n4. 十分にテスト\n5. プルリクエストを提出\n\n## 📄 ライセンス\n\nこのプロジェクトはMITライセンスの下でライセンスされています - 詳細は[LICENSE](LICENSE)ファイルを参照してください。\n\n## 🙏 謝辞\n\n- [Omeka S](https://omeka.org/s/) - デジタル出版プラットフォーム\n- [Daniel-KM](https://github.com/Daniel-KM) - IIIFモジュール開発者\n- [Traefik](https://traefik.io/) - 現代的なリバースプロキシ\n- [Docker](https://docker.com/) - コンテナ化プラットフォーム\n\n## 📞 サポート\n\n- **問題報告**: [GitHub Issues](https://github.com/nakamura196/omeka-s-docker/issues)\n- **ディスカッション**: [GitHub Discussions](https://github.com/nakamura196/omeka-s-docker/discussions)\n- **Omeka Sドキュメント**: [https://omeka.org/s/docs/](https://omeka.org/s/docs/)\n\n---\n\n**デジタルヒューマニティーズコミュニティのために ❤️ を込めて作成**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnakamura196%2Fomeka-s-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnakamura196%2Fomeka-s-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnakamura196%2Fomeka-s-docker/lists"}