Codeberg Gists #382

circlebuilder commented 2021年01月09日 07:49:23 +01:00

(I thought there was another issue asking something like "What other major services could Codeberg provide?", can't find it though)

How about Gists?

---

Background:

As (still) a Golang noob I am trying to run Go-Fed apcore activitypub example server. An involved process and I'm keeping notes. Notes are long, mixed of noob misunderstanding, project feedback, and stuff to improve later on with multiple issues + PR's.

There's no good place for the notes. Not suitable as an issue, cannot dump on Matrix, and not suitable for SocialHub forum. So...

I need a Github gist

How nice if I could have Codeberg gist instead, and refer to it from a GH issue in the project's tracker :)

(I thought there was another issue asking something like "What other major services could Codeberg provide?", can't find it though) How about Gists? --- Background: As (still) a Golang noob I am trying to run [Go-Fed apcore](https://github.com/go-fed/apcore) activitypub example server. An involved process and I'm keeping notes. Notes are long, mixed of noob misunderstanding, project feedback, and stuff to improve later on with multiple issues + PR's. There's no good place for the notes. Not suitable as an issue, cannot dump on Matrix, and not suitable for SocialHub forum. So... > I need a **Github** gist How nice if I could have Codeberg gist instead, and refer to it from a GH issue in the project's tracker :)

hw commented 2021年01月09日 21:16:55 +01:00

@momar built https://github.com/qbin-io/qbin

@momar built https://github.com/qbin-io/qbin

fnetX commented 2021年01月09日 22:03:03 +01:00

Agree. Yes, there are thousands of pastebin services out there, but using a nice one for Codeberg would be pretty cool.

Is there even one developed on Codeberg?

The best thing would be to integrate it into Codeberg, like having a button in the official UI or being able to sign in into the bin service to manage pastes or assign them to users / projects etc ...

Agree. Yes, there are thousands of pastebin services out there, but using a nice one for Codeberg would be pretty cool. Is there even one developed on Codeberg? The best thing would be to integrate it into Codeberg, like having a button in the official UI or being able to sign in into the bin service to manage pastes or assign them to users / projects etc ...

6543 commented 2021年01月09日 23:56:58 +01:00

... or being able to sign in into the bin service ...

so you just have to look for a pastebin witch has oauth2 login, create a subdomain and that mainly should it be

https://github.com/awesome-selfhosted/awesome-selfhosted#pastebins

EDIT: I could not find a good fit in the first place :/ so it looks we have to programm it ...

Upstream issue: https://github.com/go-gitea/gitea/issues/693

> ... or being able to sign in into the bin service ... so you just have to look for a pastebin witch has oauth2 login, create a subdomain and that mainly should it be https://github.com/awesome-selfhosted/awesome-selfhosted#pastebins EDIT: I could not find a good fit in the first place :/ so it looks we have to programm it ... Upstream issue: https://github.com/go-gitea/gitea/issues/693

techknowlogick commented 2021年01月10日 01:25:03 +01:00

The way that GitHub gists service works, is that it is an oauth application that uses the Github user account to login with.

One benefit of Gist is that each gist is a repo that can be cloned, etc..

A quick way to get started would be to have a "login w/ codeberg" to get oauth2 credentials, and then use the API to create repos & read/write to them.

As for upstream in Gitea, things that would need to be considered are githooks to prevent creating gists w/ folders (to match github gist behaviour), a different way to display them than standard repos (where standard repos only show content of readme, where gists would need to show all files), and also how to display them (likely a different tab from user's profile) so a sql where clause would be needed so they would be excluded from the main repo listing. And maybe comments on gists too (possible forking too)?

The way that GitHub gists service works, is that it is an oauth application that uses the Github user account to login with. One benefit of Gist is that each gist is a repo that can be cloned, etc.. A quick way to get started would be to have a "login w/ codeberg" to get oauth2 credentials, and then use the API to create repos & read/write to them. As for upstream in Gitea, things that would need to be considered are githooks to prevent creating gists w/ folders (to match github gist behaviour), a different way to display them than standard repos (where standard repos only show content of readme, where gists would need to show all files), and also how to display them (likely a different tab from user's profile) so a sql where clause would be needed so they would be excluded from the main repo listing. And maybe comments on gists too (possible forking too)?

hw commented 2021年01月10日 22:44:50 +01:00

Would these work somewhat similar to the wiki repos?

Would these work somewhat similar to the wiki repos?

techknowlogick commented 2021年01月11日 16:11:25 +01:00

Would these work somewhat similar to the wiki repos?

Indeed.

> Would these work somewhat similar to the wiki repos? Indeed.

fnetX commented 2021年05月20日 00:32:26 +02:00

Just another idea for a standalone service (without changing Gitea): What about serving a per-user / org repo called gists where you can dump in all your notes that are then fancily displayed via some gists service? If you don't want your the index to be public, you can leave the repo private?

Just another idea for a standalone service (without changing Gitea): What about serving a per-user / org repo called `gists` where you can dump in all your notes that are then fancily displayed via some gists service? If you don't want your the index to be public, you can leave the repo private?

realaravinth commented 2022年02月18日 08:25:24 +01:00

Hello,

I'm working on a gist program which will have features very similar GitHub Gists but with subtle differences:

• Directories are permitted: multi-file gists are already permitted in all implementations that I surveyed, directories allow for better organization, which is nice.
• Federation via Activity Pub: I want to support federated comments but to do that, I'll also have to support federated gists(what will users comment on? :D), therefore gists and comments will be federated(federated forking, star/favorite and comments)

Currently, it has a standalone authentication/user management mechanism(i.e people can signup using email IDs), but OAuth integration with Gitea is planned. The full feature list is available on the repository's README.

I would appreciate any inputs you might have :)

---

Also posted on Gitea issue tracker

Hello, [I'm working on a gist program](https://github.com/realaravinth/gists) which will have features very similar GitHub Gists but with subtle differences: - Directories are permitted: [multi-file gists are already permitted in all implementations that I surveyed](https://github.com/realaravinth/gists/blob/master/docs/ecosystem.md), directories allow for better organization, which is nice. - Federation via Activity Pub: I want to support federated comments but to do that, I'll also have to support federated gists(what will users comment on? :D), therefore gists and comments will be federated(federated forking, star/favorite and comments) Currently, it has a standalone authentication/user management mechanism(i.e people can signup using email IDs), but OAuth integration with Gitea is planned. The full [feature list is available on the repository's README](https://github.com/realaravinth/gists#features). I would appreciate any inputs you might have :) --- [Also posted on Gitea issue tracker](https://github.com/go-gitea/gitea/issues/16670#issuecomment-1044052785)

circlebuilder commented 2022年02月18日 08:46:51 +01:00

Very cool! You may also consider posting to forgefriends community in the Projects category. The ActivityPub federation part of Gists are interesting for Forgefriends FSDL incubator project to get documented specs on that.

Very cool! You may also consider posting to [forgefriends community](https://forum.forgefriends.org) in the [Projects](https://forum.forgefriends.org/c/discussions/projects/23) category. The ActivityPub federation part of Gists are interesting for [Forgefriends FSDL](https://forum.forgefriends.org/t/forgefriends-free-software-development-lifecycle-forge-specifications-incubator-project/586) incubator project to get documented specs on that.

fnetX commented 2022年02月18日 13:01:22 +01:00

@realaravinth Wouldn't you be able to save some backend work by considering the idea I posted above your comment?

With Git already being a storage solution, and Gitea supporting federation in the future, wouldn't it actually be possible to use this for storage (the Gists could then actually be found by other instances who don't host a Gists server).

You could use a repo with folder structure and maybe independent branches for each gist, you could use the upcoming federated comment section as a backend (and e.g. let the title indicate the gist thread).

Just an idea, because looking at your roadmap especially with federation, I suppose you'll have to spent quite a while on reinventing code that was already written + need to spend even more time having it become mature (I'm mainly talking about the Git backend, the implementation in Gitea is not trivial, needs to consider hundreds of edge cases etc).

@realaravinth Wouldn't you be able to save some backend work by considering the idea I posted above your comment? With Git already being a storage solution, and Gitea supporting federation in the future, wouldn't it actually be possible to use this for storage (the Gists could then actually be found by other instances who don't host a Gists server). You could use a repo with folder structure and maybe independent branches for each gist, you could use the upcoming federated comment section as a backend (and e.g. let the title indicate the gist thread). Just an idea, because looking at your roadmap especially with federation, I suppose you'll have to spent quite a while on reinventing code that was already written + need to spend even more time having it become mature (I'm mainly talking about the Git backend, the implementation in Gitea is not trivial, needs to consider hundreds of edge cases etc).

realaravinth commented 2022年02月18日 13:10:54 +01:00

@fnetX: What you are suggesting can save a lot of work but it's difficult to accommodate private gists with a single-repo-for-all-gists mechanism.

Also, reserving a namespace({username}/gists) after the fact might cause issues during upgrades(I'm assuming the reservation will be made in a future Gitea release).

One method to allow for maximum reuse is to make modify Gitea to listen at two different domains: one for the forge and the other for gists but I'm not a Go programmer and I'm not sure if the Gitea folks might like this idea :)

I posted a status report on the GitHub issue tracker, after someone requested an update.

@fnetX: What you are suggesting can save a lot of work but it's difficult to accommodate private gists with a single-repo-for-all-gists mechanism. Also, reserving a namespace(`{username}/gists`) after the fact might cause issues during upgrades(I'm assuming the reservation will be made in a future Gitea release). One method to allow for maximum reuse is to make modify Gitea to listen at two different domains: one for the forge and the other for gists but I'm not a Go programmer and I'm not sure if the Gitea folks might like this idea :) [I posted a status report](https://github.com/go-gitea/gitea/issues/16670#issuecomment-1044101473) on the GitHub issue tracker, after someone requested an update.

fnetX commented 2022年02月19日 13:43:47 +01:00

No, I meant one gists repo per user, as we already do it with "pages". We also allow other repos and branches, you could get inspired by this, too.

e.g. "gists.giteahost.invalid/user" displays a list of gists in the gists repo,
"gists.giteahost.invalid/user/gist/(files)" displays the gist in the named branch and the files in there and "gists.giteahost.invalid/user/@otherrepo/gist" displays a Gist from another repo, and if private, asks the user to sign in via OAuth to check if the permission was granted to that user.

I think this project should be standalone, so no need to reserve namespaces in Gitea. I think another subdomain is better, and if a site chooses they can probably also install in "giteahost.invalid/gists/..." - we could add a config parameter in Gitea to allow to define an external Git host and URL scheme for this.

No, I meant one gists repo per user, as we already do it with "pages". We also allow other repos and branches, you could get inspired by this, too. e.g. "gists.giteahost.invalid/user" displays a list of gists in the gists repo, "gists.giteahost.invalid/user/gist/(files)" displays the gist in the named branch and the files in there and "gists.giteahost.invalid/user/@otherrepo/gist" displays a Gist from another repo, and if private, asks the user to sign in via OAuth to check if the permission was granted to that user. I think this project should be standalone, so no need to reserve namespaces in Gitea. I think another subdomain is better, and if a site chooses they can probably also install in "giteahost.invalid/gists/..." - we could add a config parameter in Gitea to allow to define an external Git host and URL scheme for this.

realaravinth commented 2022年02月19日 14:11:31 +01:00

What you are suggesting will result in a much tigher integration with Gitea, and as a result, create a heavier dependency on it.

Users of this program should be able to run it without having to run a Gitea isntance. IMHO, the forge experience must be flexible and users should be able to mix and match software as they please.

What you are suggesting will result in a much tigher integration with Gitea, and as a result, create a heavier dependency on it. Users of this program should be able to run it without having to run a Gitea isntance. IMHO, the forge experience must be flexible and users should be able to mix and match software as they please.

vivi90 commented 2022年07月09日 15:48:49 +02:00

What's the current state?
Have we an GIST feature ready to use?

What's the current state? Have we an GIST feature ready to use?

Gusted commented 2022年07月09日 18:58:05 +02:00

Issue is still open, codeberg currently doens't provide any gist capabilities.

Issue is still open, codeberg currently doens't provide any gist capabilities.

crapStone commented 2024年01月15日 21:48:24 +01:00

https://github.com/thomiceli/opengist

https://github.com/thomiceli/opengist

circlebuilder commented 2024年01月18日 12:04:26 +01:00

I should mention that @realaravinth also elaborated on a gists app after commenting above, at https://github.com/realaravinth/gitpad

I should mention that @realaravinth also elaborated on a gists app after [commenting above](https://codeberg.org/Codeberg/Community/issues/382#issuecomment-378018), at https://github.com/realaravinth/gitpad

crapStone commented 2024年01月18日 12:18:42 +01:00

Yeah, I also looked into that, but it seems abandoned.

Yeah, I also looked into that, but it seems abandoned.

6543 commented 2024年01月18日 16:40:55 +01:00

I also like to projects who have more maintainers rather than a single man show :D

I also like to projects who have more maintainers rather than a single man show :D

mawfyy commented 2024年08月06日 05:44:00 +02:00

I would like to participate, how can i start or what's the progress here?

I would like to participate, how can i start or what's the progress here?

Gusted commented 2024年08月06日 15:12:38 +02:00

how can i start or what's the progress here?

The best would be to checkout https://codeberg.org/Codeberg/Contributing/

> how can i start or what's the progress here? The best would be to checkout https://codeberg.org/Codeberg/Contributing/

harald commented 2024年12月11日 13:03:28 +01:00

Now I just settled to create a repository for code snippets and notes in my profile:

https://codeberg.org/harald/Codeschnipselnotizen

Creating a new file in the Codeberg UI is simple enough. I never used github gists really, but seeing how easy the snippets repo is to set up and use, I wonder: what is the point? (No sarcasm or anything, I really don't know.)

Now I just settled to create a repository for code snippets and notes in my profile: https://codeberg.org/harald/Codeschnipselnotizen Creating a new file in the Codeberg UI is simple enough. I never used github gists really, but seeing how easy the snippets repo is to set up and use, I wonder: what is the point? (No sarcasm or anything, I really don't know.)

kryzet commented 2025年05月05日 19:47:48 +02:00

Maybe there isn't a real point. If you think about it, though, there's no point in an office suite when you could use ASCIIDoc (or HTML + CSS 😉).

Maybe there isn't a real point. If you think about it, though, there's no point in an office suite when you could use ASCIIDoc (or HTML + CSS 😉).

kryzet commented 2025年05月05日 19:49:08 +02:00

P.S. Checking the repository you shared, the experience of someone browsing your repository is probably not the same experience someone gets when they open a GitHub gist 🙂

P.S. Checking the repository you shared, the experience of someone browsing your repository is probably not the same experience someone gets when they open a GitHub gist 🙂

harald commented 2025年05月06日 16:01:23 +02:00

@kryzet Just looked again at one or two gists on github. I see some code, I can copy it. It has revisions. No idea what specifics you find so different to browsing some files in a repository. But maybe I just don't get it from the simple examples I checked.

Maybe you could write down some bullet points of what makes this gist service special and helpful. It may help to move this issue forward, one way or the other.

@kryzet Just looked again at one or two gists on github. I see some code, I can copy it. It has revisions. No idea what specifics you find so different to browsing some files in a repository. But maybe I just don't get it from the simple examples I checked. Maybe you could write down some bullet points of what makes this gist service special and helpful. It may help to move this issue forward, one way or the other.

gedankenstuecke commented 2025年05月06日 16:06:30 +02:00

For what its worth: I solved this in the same way by making a gists repo to have one-off code there (cf for an example.

The main limitation is that it doesn't allow for commenting/conversation on the same page, but imho for simple things that works well enough.

For what its worth: I solved this in the same way by making a `gists` repo to have one-off code there ([cf for an example](https://codeberg.org/gedankenstuecke/gists/src/branch/main/mastodon-notify-fosstodon.py). The main limitation is that it doesn't allow for commenting/conversation on the same page, but imho for simple things that works well enough.

kryzet commented 2025年05月06日 19:58:14 +02:00

@harald I just realized that one would normally copy a direct link to the file and not a link to the repository's root, but @gedankenstuecke's point still stands.

@harald I just realized that one would normally copy a direct link to the file and not a link to the repository's root, but @gedankenstuecke's point still stands.

ldesousa commented 2025年08月07日 16:07:27 +02:00

@harald wrote in #382 (comment):

No idea what specifics you find so different to browsing some files in a repository.

The GibLab page on snippets might give an idea. These are encapsulated code chunks unrelated to a particular repository.

Let me offer a use case. I am teaching some course with exercises along the way. On each exercise I wish to point the students to the solution after some time. If the solutions are gathered in a single repository, a single URI leads the students to all solutions. I need an encapsulated URI for each solution, so students remained focused on the exercise at hand. Moreover, students can then comment and propose enhancements to each solution individually.

I am sure similar use cases exist in the corporate world. This would indeed be a useful improvement to Codeberg.

@harald wrote in https://codeberg.org/Codeberg/Community/issues/382#issuecomment-4173359: > No idea what specifics you find so different to browsing some files in a repository. The GibLab [page on snippets](https://docs.gitlab.com/user/snippets/) might give an idea. These are encapsulated code chunks unrelated to a particular repository. Let me offer a use case. I am teaching some course with exercises along the way. On each exercise I wish to point the students to the solution after some time. If the solutions are gathered in a single repository, a single URI leads the students to all solutions. I need an encapsulated URI for each solution, so students remained focused on the exercise at hand. Moreover, students can then comment and propose enhancements to each solution individually. I am sure similar use cases exist in the corporate world. This would indeed be a useful improvement to Codeberg.