How meigoc/tulpar-server works
Tulpar Server hosts a NurOS APG package repository. The main workflow is package browsing and download, alongside authenticated publish/yank: uploaded archives are validated, stored verbatim, and indexed for API access. Supporting layers cover APG parsing, repository state, request security, and operational controls. The README documents the product capabilities; edges based on implementation are limited to relationships visible in excerpts or SOURCE INDEX references, so some internal routing and configuration wiring is not expanded.
Main entry points: ServerContext.kt Shared context · Repository.kt Repository index · PublishRoutes.kt Publish and yank · PublishService.kt Publish service
Components 26
Server runtime
- CLI entry
src/main/kotlin/meigo/tulpar/server/Main.kt - Server commands
src/main/kotlin/meigo/tulpar/server/cli/Commands.kt - Runtime config
src/main/kotlin/meigo/tulpar/server/config/TulparConfig.kt - Shared context
src/main/kotlin/meigo/tulpar/server/ServerContext.kt
REST API
- Web module
src/main/kotlin/meigo/tulpar/server/web/WebModule.kt - Package browsing
src/main/kotlin/meigo/tulpar/server/web/PackageRoutes.kt - Package downloads
src/main/kotlin/meigo/tulpar/server/web/DownloadRoutes.kt - Publish and yank
src/main/kotlin/meigo/tulpar/server/web/PublishRoutes.kt
APG and repository
- Publish service
src/main/kotlin/meigo/tulpar/server/repo/PublishService.kt - APG validation
src/main/kotlin/meigo/tulpar/server/apg/ApgValidator.kt - Archive reader
src/main/kotlin/meigo/tulpar/server/apg/ApgArchive.kt - Checksum parsing
src/main/kotlin/meigo/tulpar/server/apg/Checksums.kt - APG metadata
src/main/kotlin/meigo/tulpar/server/apg/Metadata.kt - Version handling
src/main/kotlin/meigo/tulpar/server/apg/Version.kt - Repository index
src/main/kotlin/meigo/tulpar/server/repo/Repository.kt - Package records
src/main/kotlin/meigo/tulpar/server/repo/PackageEntry.kt - Index document
src/main/kotlin/meigo/tulpar/server/repo/RepoData.kt
Security controls
- IP request guard
src/main/kotlin/meigo/tulpar/server/security/IpGuard.kt - Download limiter
src/main/kotlin/meigo/tulpar/server/security/DownloadLimiter.kt - Token auth
src/main/kotlin/meigo/tulpar/server/security/TokenAuth.kt - Path safety
src/main/kotlin/meigo/tulpar/server/security/PathSafety.kt
Operations
- Metrics collector
src/main/kotlin/meigo/tulpar/server/metrics/MetricsCollector.kt - Admin console
src/main/kotlin/meigo/tulpar/server/cli/AdminConsole.kt - Request log
src/main/kotlin/meigo/tulpar/server/util/RequestLog.kt
Other components
- Package client
- Administrator
Connections 31
- Administrator → CLI entry: starts server
README.md - CLI entry → Server commands: dispatches commands
README.md - Server commands → Runtime config: loads config
src/main/kotlin/meigo/tulpar/server/cli/Commands.kt - Server commands → Shared context: builds context
src/main/kotlin/meigo/tulpar/server/cli/Commands.kt - Shared context → Runtime config: holds config
src/main/kotlin/meigo/tulpar/server/ServerContext.kt - Shared context → Repository index: holds repository
src/main/kotlin/meigo/tulpar/server/ServerContext.kt - Shared context → Download limiter: holds limiter
src/main/kotlin/meigo/tulpar/server/ServerContext.kt - Web module → Shared context: uses context
src/main/kotlin/meigo/tulpar/server/web/WebModule.kt - Package client → Package browsing: browses packages
README.md - Package client → Package downloads: requests downloads
README.md - Package client → Publish and yank: uploads or yanks
README.md - Package browsing → Repository index: queries index
src/main/kotlin/meigo/tulpar/server/web/PackageRoutes.kt - Package downloads → Repository index: resolves package
src/main/kotlin/meigo/tulpar/server/web/DownloadRoutes.kt - Package downloads → Download limiter: limits streams
src/main/kotlin/meigo/tulpar/server/web/DownloadRoutes.kt - Publish and yank → Publish service: invokes publish
src/main/kotlin/meigo/tulpar/server/web/PublishRoutes.kt - Publish and yank → Token auth: checks bearer token
src/main/kotlin/meigo/tulpar/server/web/PublishRoutes.kt - Publish and yank → Path safety: checks path segments
src/main/kotlin/meigo/tulpar/server/web/PublishRoutes.kt - Publish service → APG validation: validates archive
src/main/kotlin/meigo/tulpar/server/repo/PublishService.kt - Publish service → Archive reader: reads archive
src/main/kotlin/meigo/tulpar/server/repo/PublishService.kt - Publish service → Repository index: stores and reindexes
src/main/kotlin/meigo/tulpar/server/repo/PublishService.kt - APG validation → Archive reader: inspects contents
src/main/kotlin/meigo/tulpar/server/apg/ApgValidator.kt - APG validation → Checksum parsing: parses checksums
src/main/kotlin/meigo/tulpar/server/apg/ApgValidator.kt - Repository index → Archive reader: scans packages
src/main/kotlin/meigo/tulpar/server/repo/Repository.kt - Repository index → Package records: indexes entries
src/main/kotlin/meigo/tulpar/server/repo/Repository.kt - Repository index → Index document: builds index
src/main/kotlin/meigo/tulpar/server/repo/Repository.kt - Admin console → Shared context: operates server
src/main/kotlin/meigo/tulpar/server/cli/AdminConsole.kt - Admin console → Metrics collector: views metrics
src/main/kotlin/meigo/tulpar/server/cli/AdminConsole.kt - Metrics collector → Shared context: samples runtime
src/main/kotlin/meigo/tulpar/server/metrics/MetricsCollector.kt - Shared context → IP request guard: holds guard
src/main/kotlin/meigo/tulpar/server/ServerContext.kt - Shared context → Token auth: holds authenticator
src/main/kotlin/meigo/tulpar/server/ServerContext.kt - Shared context → Request log: holds request log
src/main/kotlin/meigo/tulpar/server/ServerContext.kt