Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/artipie/artipie

Binary Artifact Management Tool
https://github.com/artipie/artipie

artifact-management artifact-repository-manager artipie binary-repository-manager brm free-private-repository java

Last synced: 24 days ago
JSON representation

Binary Artifact Management Tool

Awesome Lists containing this project

README 

        



[![Join our Telegramm group](https://img.shields.io/badge/Join%20us-Telegram-blue?&logo=telegram&?link=http://right&link=http://t.me/artipie)](http://t.me/artipie)



[![Javadoc](http://www.javadoc.io/badge/com.artipie/artipie.svg)](http://www.javadoc.io/doc/com.artipie/artipie)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/artipie/artipie/blob/master/LICENSE.txt)

[![codecov](https://codecov.io/gh/artipie/artipie/branch/master/graph/badge.svg)](https://app.codecov.io/gh/artipie/artipie)

[![Hits-of-Code](https://hitsofcode.com/github/artipie/artipie)](https://hitsofcode.com/view/github/artipie/artipie)

![Docker Pulls](https://img.shields.io/docker/pulls/artipie/artipie)

![Docker Image Version (latest by date)](https://img.shields.io/docker/v/artipie/artipie?label=DockerHub&sort=date)



Artipie is a binary artifact management tool, similar to

[Artifactory](https://jfrog.com/artifactory/),

[Nexus](https://www.sonatype.com/product-nexus-repository),

[Archiva](https://archiva.apache.org/),

[ProGet](https://inedo.com/proget),

and many others.

The following set of features makes Artipie unique among all others:



  * It is open source ([MIT license](https://github.com/artipie/artipie/blob/master/LICENSE.txt))

  * It is horizontally scalable, you can add servers easily

  * It is written in reactive Java (using [Vert.x](https://vertx.io/))

  * It supports

    [Maven](https://github.com/artipie/artipie/wiki/maven),

    [Docker](https://github.com/artipie/artipie/wiki/docker),

    [Rubygems](https://github.com/artipie/artipie/wiki/gem),

    [Go](https://github.com/artipie/artipie/wiki/go),

    [Helm](https://github.com/artipie/artipie/wiki/helm),

    [Npm](https://github.com/artipie/artipie/wiki/npm),

    [NuGet](https://github.com/artipie/artipie/wiki/nuget),

    [Composer](https://github.com/artipie/artipie/wiki/composer),

    [Pip](https://github.com/artipie/artipie/wiki/pypi),

    [Rpm](https://github.com/artipie/artipie/wiki/rpm),

    [Debian](https://github.com/artipie/artipie/wiki/debian),

    [Anaconda](https://github.com/artipie/artipie/wiki/anaconda)

    and [others](https://github.com/artipie/artipie/wiki/Configuration-Repository#supported-repository-types)

  * It can host the data in the file system, [Amazon S3](https://aws.amazon.com/s3/) or in a storage defined by user



Learn more about Artipie in our [Wiki](https://github.com/artipie/artipie/wiki).



**Publications about Artipie:**

- [An Easy Way to Get Your Own Binary Repository](https://dzone.com/articles/easy-way-to-get-your-own-binary-repository#)

- [Private Remote Maven Repository With Artipie](https://dzone.com/articles/private-remote-maven-repository-with-artipie-1)

- [Deployment of NPM Repositories with Artipie](https://dev.to/andpopov/deployment-of-npm-repositories-with-artipie-30co)

- [How I use Artipie, a PyPI repo](https://opensource.com/article/22/12/python-package-index-repository-artipie)

- [Готовим приватные репозитории с помощью Artipie](https://habr.com/ru/post/687394/)



# Quickstart



Artipie is distributed as Docker container and as fat `jar`. The `jar` file can be downloaded on the

GitHub [release page](https://github.com/artipie/artipie/releases) and here is a 

[Wiki page](https://github.com/artipie/artipie/wiki#how-to-start-artipie-service-with-a-maven-proxy-repository) describing how to start it.

The fastest way to start Artipie is by using Docker container. First, make sure you have already installed [Docker Engine](https://docs.docker.com/get-docker/).

Then, open command line and instruct Docker Engine to run Artipie container:



```bash

docker run -it -p 8080:8080 -p 8086:8086 artipie/artipie:latest

```



It'll start a new Docker container with latest Artipie version, the command includes mapping of two 

ports: on port `8080` repositories are served and on port `8086` Artipie Rest API and Swagger 

documentation is provided.

A new image generate default configuration, prints a list of running repositories, test 

credentials and a link to the [Swagger](https://swagger.io/) documentation to console. To check 

existing repositories using Artipie Rest API:

- go to Swagger documentation page `http://localhost:8086/api/index.html`, 

choose "Auth token" in "Select a definition" list,

- generate and copy authentication token for user `artipie/artipie`,  

- switch to "Repositories" definition, press "Authorize" button and paste the token 

- then perform `GET /api/v1/repository/list` request. 

Response should be a json list with three default repositories:

```json

[

  "my-bin",

  "my-docker",

  "my-maven"

]

```

Artipie server side (repositories) is served on `8080` port and is available on URI 

`http://localhost:8080/{reponame}`, where `{reponame}` is the name of the repository. 

Let's put some text data into binary repository:

```commandline

curl -X PUT -d 'Hello world!' http://localhost:8080/my-bin/test.txt

```

With this request we added file `test.txt` containing text "Hello world!" into repository. Let's check

it's really there:

```commandline

curl -X GET http://localhost:8080/my-bin/test.txt

```

"Hello world!" should be printed in console.



To dive in deeper into Artipie configuration, features, explore repositories and storages settings,

please, address our [Wiki](https://github.com/artipie/artipie/wiki).



Default server configuration in Docker Container refers to `/var/artipie/repo` to look up for

repository configurations. You may want to mount local configurations `` 

to `/var/artipie/repo` to check and edit it manually.



> **Important:** for provided Artipie docker containers `` should have directory ownership set to `2021:2020`. To change it correctly use `sudo chown -R 2021:2020 `.



If you have any question or suggestions, do not hesitate to [create an issue](https://github.com/artipie/artipie/issues/new) or contact us in

[Telegram](https://t.me/artipie).  

Artipie [roadmap](https://github.com/orgs/artipie/projects/3).



## How to contribute



Fork repository, make changes, send us a pull request. We will review

your changes and apply them to the `master` branch shortly, provided

they don't violate our quality standards. To avoid frustration, before

sending us your pull request please run full Maven build:



```

$ mvn clean install

```



To avoid build errors use Maven 3.2+ and please read 

[contributing rules](https://github.com/artipie/artipie/blob/master/CONTRIBUTING.md).



Thanks to [FreePik](https://www.freepik.com/free-photos-vectors/party) for the logo.



## How to release



Artipie service is released in several formats: 

- [docker image in DockerHub](https://hub.docker.com/r/artipie/artipie)

- [docker image based on Ubuntu](https://hub.docker.com/r/artipie/artipie-ubuntu)

- jar archive with dependencies in GitHub release page ([example](https://github.com/artipie/artipie/releases/tag/v0.30.1))

- asto modules, artipie-core, http-client, vertx-server and each adapter are released as jars into Maven central



All these distributions are created by GitHub [workflows](.github/workflows). To

publish release, push tag starting with `v` into this repository masted branch:

```bash

git tag v1.2.0

git push --tags origin

```