Unpub is a self-hosted private Dart Pub server for Enterprise, with a simple web interface to search and view packages information.
pub global activate unpub
unpub --database mongodb://localhost:27017/dart_pub # Replace this with production database uriUnpub use mongodb as meta information store and file system as package(tarball) store by default.
Dart API is also available for further customization.
import 'package:mongo_dart/mongo_dart.dart'; import 'package:unpub/unpub.dart' as unpub; main(List<String> args) async { final db = Db('mongodb://localhost:27017/dart_pub'); await db.open(); // make sure the MongoDB connection opened final app = unpub.App( metaStore: unpub.MongoStore(db), packageStore: unpub.FileStore('./unpub-packages'), ); final server = await app.serve('0.0.0.0', 4000); print('Serving at http://${server.address.host}:${server.port}'); }
| Option | Description | Default |
|---|---|---|
metaStore (Required) |
Meta information store | - |
packageStore (Required) |
Package(tarball) store | - |
upstream |
Upstream url | https://pub.dev |
googleapisProxy |
Http(s) proxy to call googleapis (to get uploader email) | - |
uploadValidator |
See Package validator | - |
Using unpub behind reverse proxy(nginx or another), ensure you have necessary headers
proxy_set_header X-Forwarded-Host $host; proxy_set_header X-Forwarded-Server $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; # Workaround for: # Asynchronous error HttpException: # Trying to set 'Transfer-Encoding: Chunked' on HTTP 1.0 headers proxy_http_version 1.1;
Naming conflicts is a common issue for private registry. A reasonable solution is to add prefix to reduce conflict probability.
With uploadValidator you could check if uploaded package is valid.
var app = unpub.App( // ... uploadValidator: (Map<String, dynamic> pubspec, String uploaderEmail) { // Only allow packages with some specified prefixes to be uploaded var prefix = 'my_awesome_prefix_'; var name = pubspec['name'] as String; if (!name.startsWith(prefix)) { throw 'Package name should starts with $prefix'; } // Also, you can check if uploader email is valid if (!uploaderEmail.endsWith('@your-company.com')) { throw 'Uploader email invalid'; } } );
Unpub is designed to be extensible. It is quite easy to customize your own meta store and package store.
import 'package:unpub/unpub.dart' as unpub; class MyAwesomeMetaStore extends unpub.MetaStore { // Implement methods of MetaStore abstract class // ... } class MyAwesomePackageStore extends unpub.PackageStore { // Implement methods of PackageStore abstract class // ... } // Then use it var app = unpub.App( metaStore: MyAwesomeMetaStore(), packageStore: MyAwesomePackageStore(), );
- unpub_aws: AWS S3 package store, maintained by @CleanCode.
| URL | Badge |
|---|---|
/badge/v/{package_name} |
|
/badge/d/{package_name} |
- pub-dev: Source code of pub.dev, which should be deployed at Google Cloud Platform.
- pub_server: An alpha version of pub server provided by Dart team.
- pub-dev: Web page styles are mostly imported from https://pub.dev directly.
- shields: Badges generation.
MIT