unpub 1.2.1

Dart native
Flutter Android iOS

Self-hosted private Dart Pub server for Enterprise, with a simple web interface to search and view packages information.

Unpub #

build pub

Unpub is a self-hosted private Dart Pub server for Enterprise, with a simple web interface to search and view packages information.

Screenshots #

Screenshot

Usage via command line #

pub global activate unpub
unpub --database mongodb://localhost:27017/dart_pub # Replace this with production database uri

Unpub use mongodb as meta information store and file system as package(tarball) store by default.

Dart API is also available for further customization.

Usage via Dart API #

Example #

import 'package:unpub/unpub.dart' as unpub;

main(List<String> args) async {
  var basedir = '/path/to/basedir'; // Base directory to save pacakges
  var db = 'mongodb://localhost:27017/dart_pub'; // MongoDB uri

  var metaStore = unpub.MongoStore(db);
  await metaStore.db.open();

  var packageStore = unpub.FileStore(basedir);

  var app = unpub.App(
    metaStore: metaStore,
    packageStore: packageStore,
  );

  var server = await app.serve('0.0.0.0', 4000);
  print('Serving at http://${server.address.host}:${server.port}');
}

Options #

OptionDescriptionDefault
metaStore (Required)Meta information store-
packageStore (Required)Package(tarball) store-
upstreamUpstream urlhttps://pub.dev
googleapisProxyHttp(s) proxy to call googleapis (to get uploader email)-
overrideUploaderEmailIf specified, unpub will use this email as uploader instead of requesting googleapis-
uploadValidatorSee Package validator-

Package validator #

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';
    }
  }
);

Customize meta and package store #

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(),
)

Badges #

URLBadge
/badge/v/{package_name} (version < 1.0.0)badge example
/badge/v/{package_name} (version >= 1.0.0)badge example
/badge/d/{package_name}badge example

Alternatives #

  • 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.

Credits #

License #

MIT

6
likes
70
pub points
48%
popularity

Self-hosted private Dart Pub server for Enterprise, with a simple web interface to search and view packages information.

Repository (GitHub)
View/report issues

Uploader

pd4d10@gmail.com

License

MIT (LICENSE)

Dependencies

archive, args, googleapis, http, http_parser, intl, json_annotation, logging, meta, mime, mongo_dart, path, pub_semver, shelf, shelf_router, yaml

More

Packages that depend on unpub