snap-packaging for gitea #2568

tbraeutigam · 2017-09-21T16:08:41Z

As per @kwill 's request in tbraeutigam/gogs-snap#1 and #2539, I modified my gogs-snap to fit with gitea.

Changes to Gitea Code:

None for actual code
.gitignore:
Adding a couple of exceptions for snapcraft files that might come up during compilation.

New Files:

snap/snapcraft.yaml
The snap package instructions
snap/helpers/simple_launcher.sh
A simplistic wrapper for gitea, to fit with the snap environment
snap/helpers/directorySetup.sh
Sets up the directories/copied data from r/o $SNAP to $SNAP_DATA and $SNAP_COMMON
snap/helpers/snapApp.ini
A few default settings (really 99% of changes are to adjust the paths properly for the Snap environment).

Rationale:
A snap version allows for quick testing and/or easy local hosting on your own machine/own network.
The snap does not restrict you from using any of the database options. It defaults to Sqlite3 on the setup page as that is what can be immediately used without further issues from within the snap.

Tested Scenarios:

Ran through a couple of coming use cases (create repo, issues, clone/pull/push, PR, etc)
Builds fine from current master (Tested on Ubuntu 17.04 and 16.04 LTS)

If you do accept the pull-request it would be great if you could set up gitea to be automatically build via https://build.snapcraft.io -- it will allow it to be built on any commit to the master branch (or any other branch you specify).

-> add _source.tar.bz2 to .gitignore (used by snapcraft cleanbuild)

codecov-io · 2017-09-21T16:26:27Z

Codecov Report

Merging #2568 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2568   +/-   ##
=======================================
  Coverage   20.17%   20.17%           
=======================================
  Files         145      145           
  Lines       29171    29171           
=======================================
  Hits         5884     5884           
  Misses      22393    22393           
  Partials      894      894

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 02ecc03...34071af. Read the comment docs.

sapk · 2017-09-21T18:08:11Z

Is it possible to put the snap folder under contrib/ ?

tbraeutigam · 2017-09-21T18:19:08Z

I've never tried (it's certainly not the norm, and used to be that the contents were in the root). But as it otherwise allows arbitrary source paths, it should be an option. It definitively won't work with the automated build service, though. If having the snap package information in the root is undesired, the more common option would be to hold them in a separate repository - this would take away from the automation again, as only commits to the repository containing the snap info would be monitored.

…

On Thu, 21 Sep 2017, 19:08 Antoine GIRARD ***@***.***> wrote: Is it possible to put the snap folder under contrib/ ? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#2568 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGZSKeyc2bb17sBQn0JGmzAAHfiEa0VJks5skqYQgaJpZM4Pfj0z> .

jonasfranz · 2017-09-21T19:07:19Z

snap/helpers/app.ini

@@ -0,0 +1,69 @@
+APP_NAME    = Gitea: Go Git Service
+RUN_USER    = root


Should gitea really run as root? Or do I misinterpret this variable?

It's not a misinterpretation.
Snap packages right now all 'run as root' for daemons.

The security part here is defined via apparmor confinement. With the plugs in snapcraft.yaml the root user is only allowed to access the snap directories and network access and port binding.

That's all right then.

jonasfranz · 2017-09-21T19:08:24Z

snap/helpers/directorySetup.sh

+  export isRoot=`true`
+else
+  echo "You are not running gitea as root. This is required for the snap package."
+  echo "Please re-run as root."


Why is it requried to run Gitea as root? (I am not familiar with snap-things)

There could be a way to run it as a user of started manually. While working on the gigs snap though, that got messy very fast. This I stepped that out to be revisited at a later point.

Sorry, typing on mobile:
if started*
s/gigs/gogs/
Thus I backed that*

Hi @tbraeutigam, sorry for bringing this up 2 years after the PR, but do you recall exactly which issue prevented gitea web from running correctly without daemon mode?

- Take advantage of install-hooks (snapd 2.27) - Use snapctl configuration storage for unchanging values

tbraeutigam · 2017-09-22T14:03:18Z

Hi,
I just pushed a few updates to the PR that streamline the wrapper around gitea and move install-time code to the install-hook of snapd.

This moves the snap/helpers/directorySetup.sh to snap/hooks/install and removes it from being run on every call of the gitea binary.

Hope my prior comments and this commit help clean and clear it up a bit.

tbraeutigam · 2017-10-02T12:55:33Z

Is there anything I can do for getting approval?

lunny · 2017-10-02T14:10:46Z

@tbraeutigam since not all of the maintainers are familiar with snap-packaging, I think it needs some time.

tbraeutigam · 2017-10-03T07:50:30Z

@lunny That's perfectly valid. If there is anything that I can help clarify/assist with, I'm more than happy to.

lunny · 2018-01-25T09:22:02Z

truested LGTM @tbraeutigam

sapk

Just a little comment.
For the rest, I will trust @tbraeutigam

sapk · 2018-01-25T09:31:51Z

snap/helpers/app.ini

+SSH_ROOT          = SNAP_DIR_COMMON/ssh
+SSH_KEY_TEST_PATH = SNAP_DIR_DATA/sshkeytest
+CERT_FILE         = SNAP_DIR_DATA/certs/cert.pem
+KEY_FILE          = SNAP_DIR_DATA/certs/key.pem


CERT_FILE and KEY_FILE aren't need if protocol is http. Maybe we could generate some at install and default to https ?

A fair bit of time has gone by since the writing and a lot of new features have come to snapcraft, so I'll re-check this. These entries were added back then because I judged including a full config-writer or something hack-ish would've been more costly than having these two lines in there.

I've kept them in, and in a way 'made it worse' by moving to the snap hooks for configuration.

Doing that I'm using the defaults from app.ini.sample, overwriting the parts necessary for a snap to function and adding them all to the app.ini as used by gitea.

I personally prefer this, as it's now possible to configure everything via sudo snap set category-subcategory.option, but it has some drawbacks at the moment, as I didn't want to touch the config system:

Cateogories in the style of category.subcategory are now category-subcategory

Options containing an underscore have a '99' in its place (ssh.minimum_key_size is ssh-minimum99key99size for snapctl)

New defaults do not apply automatically

Service-restart takes longer (it re-parses the whole app.ini every time)

All options can still be changed manually in the app.ini file and will be added to snapctl upon service-restart.

Not sure which way is preferred, but unless we'll touch the config system for this, there's not much that can be done (aside from completely leaving it alone and up to the user to set everything).

I would love to have it fully integrated into the snap config system as an option, but that would require a lot of work:

Category names are only allowed to be lower case and can only contain dashes

There is no programmatic interface from what I can see, all has to be done with exec() calls.

ini files are regrettably hard to convert to the json-based snapctl config format.
(You can see some of the mess by looking at the configuration.sh files ToSnap and ToIni functions...)

bkcsoft · 2018-02-10T07:29:59Z

Why isn't this a separate repo like gogs-snap and gitea-homebrew ? 🤔

bkcsoft · 2018-02-10T07:32:51Z

Is there any way to trigger the snapcraft buildservers from Drone? 🤔

EDIT: Was already answered in the issue #2539 (comment)

To get it onto build.snapcraft.io, you just have to go to the site, create an account and log in, and it guides you on how to allow the site to set a trigger for building.

lunny · 2018-04-29T05:00:41Z

@bkcsoft It seems snap don't support that usage? @tbraeutigam

lofidevops · 2018-05-09T09:10:17Z

@bkcsoft , in response to your query:

Why isn't this a separate repo like gogs-snap and gitea-homebrew ?

An earlier comment by @tbraeutigam :

[Putting snap package information in a separate repo] would take away from the automation again, as only commits to the repository containing the snap info would be monitored.

tbraeutigam · 2019-12-09T16:29:59Z

Hi @pokemaster7, I believe the issue was with Daemon-Integration in snapd not dealing well with user-level systemd or similar... But I *could* be wrong at this time.

…

On Sun, 8 Dec 2019 at 20:14, pokemaster7 ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In snap/helpers/directorySetup.sh <#2568 (comment)>: > @@ -0,0 +1,59 @@ +#!/bin/bash + +SDATA=''; SCOMMON=''; +if env | grep -q root; then + export SDATA=$(echo $SNAP_DATA | sed s!$SNAP_REVISION!current!) + export SCOMMON="$SNAP_COMMON" + export isRoot=`true` +else + echo "You are not running gitea as root. This is required for the snap package." + echo "Please re-run as root." Hi @tbraeutigam <https://github.com/tbraeutigam>, sorry for bringing this up 2 years after the PR, but do you recall exactly which issue prevented gitea web from running correctly without daemon mode? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2568?email_source=notifications&email_token=ABTFEKLRCOBHQLPDVUKA7TTQXVBPTA5CNFSM4D36HUZ2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCOLHCWA#discussion_r355207886>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABTFEKMLG5X4L6LLFM5ERO3QXVBPTANCNFSM4D36HUZQ> .

tbraeutigam added 2 commits September 21, 2017 14:22

Modify tbraeutigam/gogs-snap for gitea

f9211d5

Fix building on 16.04 (manually build go-bindata).

7ebfe93

-> add _source.tar.bz2 to .gitignore (used by snapcraft cleanbuild)

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Sep 21, 2017

jonasfranz reviewed Sep 21, 2017

View reviewed changes

lunny added the topic/build PR changes how Gitea is built, i.e. regarding Docker or the Makefile label Sep 22, 2017

lunny added this to the 1.x.x milestone Sep 22, 2017

Streamline Snap packaging:

412e695

- Take advantage of install-hooks (snapd 2.27) - Use snapctl configuration storage for unchanging values

tboerger added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 25, 2018

sapk approved these changes Jan 25, 2018

View reviewed changes

tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 25, 2018

Thorben Bräutigam and others added 5 commits January 25, 2018 17:57

Merge remote-tracking branch 'upstream/master'

6ebf2e0

Move to using Snap Hooks for configuration

82629f3

Missed re-adding daemon statement

68f7545

Merge branch 'master' into master

182651a

Fix two warnings from Codacy.

06982ca

tbraeutigam force-pushed the master branch from 6eb9762 to 06982ca Compare January 30, 2018 08:22

Merge branch 'master' into master

34071af

lunny modified the milestones: 1.x.x, 1.5.0 May 9, 2018

lunny merged commit 14f16d6 into go-gitea:master May 9, 2018

lunny mentioned this pull request May 9, 2018

Consider snap/flatpak packaging for Gitea #2539

Closed

2 tasks

go-gitea locked and limited conversation to collaborators Nov 24, 2020

		@@ -0,0 +1,69 @@
		APP_NAME = Gitea: Go Git Service
		RUN_USER = root

Uh oh!

snap-packaging for gitea #2568

snap-packaging for gitea #2568

Uh oh!

Conversation

tbraeutigam commented Sep 21, 2017

Uh oh!

codecov-io commented Sep 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sapk commented Sep 21, 2017

Uh oh!

tbraeutigam commented Sep 21, 2017 via email

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tbraeutigam commented Sep 22, 2017

Uh oh!

tbraeutigam commented Oct 2, 2017

Uh oh!

lunny commented Oct 2, 2017

Uh oh!

tbraeutigam commented Oct 3, 2017

Uh oh!

lunny commented Jan 25, 2018

Uh oh!

sapk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tbraeutigam Jan 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bkcsoft commented Feb 10, 2018

Uh oh!

bkcsoft commented Feb 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lunny commented Apr 29, 2018

Uh oh!

lofidevops commented May 9, 2018

Uh oh!

tbraeutigam commented Dec 9, 2019 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

codecov-io commented Sep 21, 2017 •

edited

Loading

tbraeutigam Jan 29, 2018 •

edited

Loading

bkcsoft commented Feb 10, 2018 •

edited

Loading