Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pd4d10/unpub

Self-hosted private Dart Pub server for Enterprise
https://github.com/pd4d10/unpub

dart enterprise flutter pub self-hosted

Last synced: 2 days ago
JSON representation

Self-hosted private Dart Pub server for Enterprise

Host: GitHub
URL: https://github.com/pd4d10/unpub
Owner: pd4d10
License: mit
Created: 2019-04-06T06:06:47.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-07-23T14:27:33.000Z (5 months ago)
Last Synced: 2024-12-14T15:02:52.217Z (9 days ago)
Topics: dart, enterprise, flutter, pub, self-hosted
Language: Dart
Homepage: https://pub.dev/packages/unpub
Size: 1.38 MB
Stars: 443
Watchers: 11
Forks: 137
Open Issues: 41
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Unpub

[![pub](https://img.shields.io/pub/v/unpub.svg)](https://pub.dev/packages/unpub)

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

## Screenshots

![Screenshot](https://raw.githubusercontent.com/bytedance/unpub/master/assets/screenshot.png)

## Usage

### Command Line

```sh

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.

### Dart API

```dart

import 'package:mongo_dart/mongo_dart.dart';

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

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

}

```

### Options

| 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](#package-validator) | - |

### Usage behind reverse-proxy

Using unpub behind reverse proxy(nginx or another), ensure you have necessary headers

```sh

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;

```

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

```dart

var app = unpub.App(

  // ...

  uploadValidator: (Map 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.

```dart

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

);

```

#### Available Package Stores

1. [unpub_aws](https://github.com/bytedance/unpub/tree/master/unpub_aws): AWS S3 package store, maintained by [@CleanCode](https://github.com/Clean-Cole).

## Badges

| URL | Badge |

| --- | --- |

| `/badge/v/{package_name}` | ![badge example](https://img.shields.io/static/v1?label=unpub&message=0.1.0&color=orange) ![badge example](https://img.shields.io/static/v1?label=unpub&message=1.0.0&color=blue) |

| `/badge/d/{package_name}` | ![badge example](https://img.shields.io/static/v1?label=downloads&message=123&color=blue) |

## Alternatives

- [pub-dev](https://github.com/dart-lang/pub-dev): Source code of [pub.dev](https://pub.dev), which should be deployed at Google Cloud Platform.

- [pub_server](https://github.com/dart-lang/pub_server): An alpha version of pub server provided by Dart team.

## Credits

- [pub-dev](https://github.com/dart-lang/pub-dev): Web page styles are mostly imported from https://pub.dev directly.

- [shields](https://shields.io): Badges generation.

## License

MIT