--- layout: '~/layouts/Markdown.astro' title: 'RubyGems Packages Repository' license: 'Apache-2.0' origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/packages/rubygems.en-us.md' --- Publish [RubyGems](https://guides.rubygems.org/) packages for your user or organization. ## Requirements To work with the RubyGems package registry, you need to use the [gem](https://guides.rubygems.org/command-reference/) command line tool to consume and publish packages. ## Configuring the package registry To register the package registry edit the `~/.gem/credentials` file and add: ```ini --- https://forgejo.example.com/api/packages/{owner}/rubygems: Bearer {token} ``` | Parameter | Description | | --------- | ------------------------------------------------------------------------------------------------ | | `owner` | The owner of the package. | | `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). | For example: ``` --- https://forgejo.example.com/api/packages/testuser/rubygems: Bearer 3bd626f84b01cd26b873931eace1e430a5773cc4 ``` ## Publish a package Publish a package by running the following command: ```shell gem push --host {host} {package_file} ``` | Parameter | Description | | -------------- | -------------------------------- | | `host` | URL to the package registry. | | `package_file` | Path to the package `.gem` file. | For example: ```shell gem push --host https://forgejo.example.com/api/packages/testuser/rubygems test_package-1.0.0.gem ``` You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first. ## Install a package To install a package from the package registry you can use [Bundler](https://bundler.io) or `gem`. ### Bundler Add a new `source` block to your `Gemfile`: ``` source "https://forgejo.example.com/api/packages/{owner}/rubygems" do gem "{package_name}" end ``` | Parameter | Description | | -------------- | ------------------------- | | `owner` | The owner of the package. | | `package_name` | The package name. | For example: ``` source "https://forgejo.example.com/api/packages/testuser/rubygems" do gem "test_package" end ``` Afterwards run the following command: ```shell bundle install ``` ### gem Execute the following command: ```shell gem install --host https://forgejo.example.com/api/packages/{owner}/rubygems {package_name} ``` | Parameter | Description | | -------------- | ------------------------- | | `owner` | The owner of the package. | | `package_name` | The package name. | For example: ```shell gem install --host https://forgejo.example.com/api/packages/testuser/rubygems test_package ``` ## Supported commands ``` gem install bundle install gem push ```