https://github.com/pertsevds/nbpm

With Nbpm you don't need EPMD daemon. No additional daemons, no additional configs. Easy and simple distribution without EPMD.
https://github.com/pertsevds/nbpm

elixir epmd

Last synced: about 2 months ago
JSON representation

With Nbpm you don't need EPMD daemon. No additional daemons, no additional configs. Easy and simple distribution without EPMD.

• Host: GitHub
• URL: https://github.com/pertsevds/nbpm
• Owner: pertsevds
• License: apache-2.0
• Created: 2023-09-12T10:37:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-08T14:20:41.000Z (about 1 year ago)
• Last Synced: 2024-04-08T17:47:11.729Z (about 1 year ago)
• Topics: elixir, epmd
• Language: Elixir
• Homepage:
• Size: 45.9 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Nbpm

Name-Based Port Mapper

---

[![CI](https://github.com/pertsevds/nbpm/actions/workflows/ci.yml/badge.svg)](https://github.com/pertsevds/nbpm/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/pertsevds/nbpm/badge.svg?branch=main)](https://coveralls.io/github/pertsevds/nbpm?branch=main)

[![Hex.pm License](https://img.shields.io/hexpm/l/nbpm)](https://hex.pm/packages/nbpm)

[![Hex.pm Version](https://img.shields.io/hexpm/v/nbpm)](https://hex.pm/packages/nbpm)

[![Hex.pm Docs](https://img.shields.io/badge/hex-docs-lightgreen)](https://hexdocs.pm/nbpm)

[![Hex.pm Downloads](https://img.shields.io/hexpm/dt/nbpm)](https://hex.pm/packages/nbpm)

With Nbpm you don't need EPMD daemon.

No additional daemons, no additional configs.

Easy and simple distribution without EPMD.

## Features

- `Mix.Release` compatibility.

- Ability to specify port number in the node name.

- Hash-Based Port from node name.

- [Mix task to get port number from node name](#mix-task-to-get-port-number-from-node-name).

## Installation

To use `Nbpm` in your Elixir project, add it as a dependency

in your `mix.exs` file:

```elixir

def deps do

[

    {:nbpm, "~> 0.3.1"}

]

end

```

Run

```shell

mix deps.get

```

to download it.

Then run

```shell

mix nbpm.install

```

to install Nbpm into your project.

> [!NOTE]

> `mix nbpm.install` will add `-start_epmd false -epmd_module Elixir.Nbpm` to

> `ELIXIR_ERL_OPTIONS` in files `rel/env.sh.eex` and `rel/env.bat.eex`.

>

> This will disable loading of EPMD daemon

> and will use Nbpm module to map node names to ports.

## Mix task to get port number from node name

You can get port number for your current app name

by using `nbpm.get_port_number` task:

```shell

mix nbpm.get_port_number

```

`mix nbpm.get_port_number` will output port number for your current app.

Or you can supply any node name as an argument:

```shell

mix nbpm.get_port_number my_app

```

`mix nbpm.get_port_number my_app` will output port number

for `my_app` node name.

## Todo

Installation to global: 

## Documentation