HexMini — self-hosted minimal hex.pm

• Installation
• Usage
• Configuration
• Roadmap
• Contributing

---

Installation

Generate Keypair

$ openssl genpkey -algorithm RSA -out private_key.pem -pkeyopt rsa_keygen_bits:2048
$ openssl rsa -pubout -in private_key.pem -out public_key.pem

Start HexMini using Docker Compose

Copy docker-compose.yml from this repo, open, configure with your keys and credentials, then run:

$ docker-compose up -d

---

Usage

Register private repo on your machine

$ curl http://<HOST>/public_key -so ~/.hex/<REPO_NAME>.pem
$ mix hex.repo add <REPO_NAME> http://<HOST> --public-key ~/.hex/<REPO_NAME>.pem --auth-key <AUTH_KEY>

Use it to fetch packages

defp deps do
  [
    {:package, "~> 1.0", repo: "<REPO_NAME>"},
  ]
end

Use it to publish packages

$ HEX_API_URL=http://<HOST> HEX_API_KEY=<AUTH_KEY> mix hex.publish package

---

Configuration

You can configure HexMini release with theese env variables:

HM_PUBLIC_KEY       # public key contents or path to file
HM_PRIVATE_KEY      # private key contents or path to file
HM_DATA_PATH        # data path, default to: /var/lib/hex_mini
HM_CREDENTIALS_FILE # path to credentials file

HM_CREDENTIALS_FILE

Credentials file should follow this format:

<username>:<auth_token>

Like:

john_doe@local.dev:auth_token1
john_doe:auth_token2

---

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request