Differences

This shows you the differences between two versions of the page.

--- gitlab_satis [2018/08/16 09:06] – admin
+++ gitlab_satis [2018/11/14 15:12] – [Configuration] admin
@@ Line 1: / Line 1: @@
+====== Using Gitlab and Satis to generate private composer Repository ======
+[[https://github.com/ochorocho/gitlab-pages-satis|This]] is mainly a wrapper for [[https://github.com/mborne/satis-gitlab|mborne/satis-gitlab]] intended to make it easy to use with minimal and simple configuration. Best used together with Gitlab. <del>I'm using Gitlab Pages behind **Apache**,</del> NGINX is the default/recommended way to use Gitlab Pages with.
+**Idea**
+  * <del>.satisinclude - file to activate certain projects for satis</del> Works in latest master [[https://github.com/ochorocho/satis-gitlab|ochorocho/satis-gitlab]] -- see [[https://github.com/mborne/satis-gitlab/pull/21|pull request]]
+  * <del>Integrate webhook ??? when tag created</del> See section [[gitlab_satis#optional|optional]]
+  * <del>Download zips in Satis ??? So no key auth is required??!?!?</del> add ''archive: true'' and *.tar-Files for Tags will be saved in ''./dist/'' Folder. Branches still point to Git Repo.
+  * <del>Multiple packages, which one is preferred?</del> Depends on the loading order of your defined repositories in composer.json
+  * FIXME Run pipeline only if it is not already running, pile up all requests and run it only once.
+**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 [[https://hub.docker.com/r/ochorocho/gitlab-pages-satis/|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''
+<code yaml .gitlab-ci.yml>
+stages:
+  - deploy
+pages:
+  stage: deploy
+  image: ochorocho/gitlab-pages-satis:latest
+  script:
+    - mkdir satis-build
+    - gitlab-pages-satis
+    - mv satis-build public
+  artifacts:
+    paths:
+    - public/
+  only:
+  - master
+</code>
+===== Configuration =====
+Go to Project -> Settings -> CI/CD -> Pipeline Triggers, give it a name and allow api scope. Hit "Add Trigger" 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.
+{{::gitlab-satis-config.png?1000|Gitlab Satis Configuration}}
+=== 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''
+<code yaml 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"
+  include-if-has-file: '.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"
+build-dir: "satis-build"
+</code>
+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 [[https://github.com/mborne/satis-gitlab|mborne/satis-gitlab]]
+<code javascript 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"
+}
+</code>
+=== 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
+<code ruby 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 refs to compare
+	payloadCurrent = "#{payload['ref']}"
+	payloadBefore = File.read(shaFile) if File.exist?(shaFile)
+	# Save refs to compare on next run ...
+	File.delete(shaFile) if File.exist?(shaFile)
+	File.write(shaFile, "#{payload['ref']}")
+	# Trigger Pipeline
+ 	if payloadBefore != payloadCurrent
+ 		exec('curl --request POST --form "token=XXXXXXXXX" --form ref=master https://gitlab.domain.com/api/v4/projects/{YOUR_SATIS_PROJECT_ID}/trigger/pipeline')
+	end
+end
+</code>

Differences

Page Tools