Using Gitlab and Satis to generate private composer Repository

This is mainly a wrapper for mborne/satis-gitlab intended to make it easy to use with minimal and simple configuration. Best used together with Gitlab. I'm using Gitlab Pages behind Apache, nginx is the default/recommended way to use Gitlab Pages with.

Idea

~~.satisinclude - file to activate certain projects for satis~~ Works in latest master ochorocho/satis-gitlab – see pull request
~~Integrate webhook ??? when tag created~~ See section optional
~~Download zips in Satis ??? So no key auth is required??!?!?~~ add archive: true and *.tar-Files for Tags will be saved in ./dist/ Folder. Branches still point to Git Repo.
~~Multiple packages, which one is preferred?~~ Depends on the loading order of your defined repositories in composer.json

Features

Write .htaccess according to config.yml (only if basic-auth is set)
build-dir to configure target folder
Order to read configuration: GITLAB_SATIS_CONFIG → config.yml
options is passed to satis-gitlab as –option
arguments is passed to satis-gitlab as argument
Use –ignore to exclude certain repos

Gitlab CI

The image ochorocho/gitlab-pages-satis provides gitlab-pages-satis command which reads the environment variable GITLAB_SATIS_CONFIG first. Fallback is ./config.yml or the configured file e.g. gitlab-pages-satis /path/to/config.yml

.gitlab-ci.yml

stages:
  - deploy

pages:
  stage: deploy
  image: ochorocho/gitlab-pages-satis:latest
  script:
    - mkdir public
    - gitlab-pages-satis
  artifacts:
    paths:
    - public/
  only:
  - master

Configuration

Go to User Settings → Access Tokens, give it a name and allow api scope. Hit “Create personal access token” and copy it to your configuration (arguments → gitlab-token). See below …

Using Environment variable

In Gitlab go to Project → Settings → CI / CD → Variables and create variable named $GITLAB_SATIS_CONFIG and add your config to the “input variable value” field.

Using Config File

Add a config file to your repository. By default the script is looking for config.yml file. If you want to change that simply call the script this way gitlab-pages-satis /path/to/custom_config.yml

config.yml

arguments:
  gitlab-url: "https://gitlab.example.org"
  gitlab-token: "GITLAB_TOKEN"
options:
  ignore: "(^namespace_name|^namespace\/project)"
  homepage: "https://satis.example.org"
  output: "satis.json"
  use-file-to-include: '.satisinclude'
  template: '/path/to/satis-template.example.json'
  archive: true
basic-auth:
  auth-name: "Satis Repository"
  auth-file: "/path/to/.htpasswd" # Absolute path required
  username: "admin"
  password: "password"

Make sure Gitlab Pages is activated for your project.

Trigger the Pipeline, that's it!

Optional

Satis example template

Use this template and set configuration (options → template) if you want to modify …

the Twig template
to use http instead of https
and all other options that are not covered by mborne/satis-gitlab

satis-template.json

{
    "name": "SATIS repository",
    "homepage": "http://localhost/satis/",
    "require": [],
    "require-dependencies": true,
    "require-dev-dependencies": true,
    "config": {
      "secure-http": false // Not required for https
    },
    "twig-template": "template/index.html.twig"
}

Trigger on tag_push

Want to trigger your satis projects pipeline each time a Tag is created/deleted ?

Add the follwing file to /opt/gitlab/embedded/service/gitlab-rails/plugins/gitlab_pages_satis.rb
Make it executable (chmod +x gitlab_pages_satis.rb)
validate your plugins using sudo gitlab-rake plugins:validate to make sure its running

gitlab_pages_satis.rb

#!/usr/bin/env ruby
 
require 'json'
require 'tmpdir'
 
payload = JSON.parse(STDIN.read)
 
# Only run this code in case we are dealing with tag_push event
if payload['event_name'] == 'tag_push'
 
	temp = Dir.tmpdir()
	shaFile = "#{temp}/gitlab-trigger.sha"
 
	# Get hash values to compare
	payloadHash = "#{payload['before']} #{payload['after']}"
	payloadHashBefore = File.read(shaFile) if File.exist?(shaFile)
 
	# Save before and after hash to compare
	File.delete(shaFile) if File.exist?(shaFile)
	File.write(shaFile, "#{payload['before']} #{payload['after']}")
 
	# Trigger Pipeline
 	if payloadHashBefore != payloadHash
 		exec('curl --request POST --form "token=XXXXXXX" --form ref=master https://gitlab.example.org/api/v4/projects/36/trigger/pipeline')
	end
end

−Table of Contents