MirrorHub/forgejo
0
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-29 11:27:44 +01:00
Code Issues Projects Releases Packages Wiki Activity
forgejo/docs/content/page/index.en-us.md
mrsdizzie 4563eb873d
Support unicode emojis and remove emojify.js (#11032) 
* Support unicode emojis and remove emojify.js

This PR replaces all use of emojify.js and adds unicode emoji support to various areas of gitea.

This works in a few ways:

First it adds emoji parsing support into gitea itself. This allows us to

 * Render emojis from valid alias (😄)
 * Detect unicode emojis and let us put them in their own class with proper aria-labels and styling
 * Easily allow for custom "emoji"
 * Support all emoji rendering and features without javascript
 * Uses plain unicode and lets the system render in appropriate emoji font
 * Doesn't leave us relying on external sources for updates/fixes/features

That same list of emoji is also used to create a json file which replaces the part of emojify.js that populates the emoji search tribute. This file is about 35KB with GZIP turned on and I've set it to load after the page renders to not hinder page load time (and this removes loading emojify.js also)

For custom "emoji" it uses a pretty simple scheme of just looking for /emojis/img/name.png where name is something a user has put in the "allowed reactions" setting we already have. The gitea reaction that was previously hard coded into a forked copy of emojify.js is included and works as a custom reaction under this method.

The emoji data sourced here is from https://github.com/github/gemoji which is the gem library Github uses for their emoji rendering (and a data source for other sites). So we should be able to easily render any emoji and :alias: that Github can, removing any errors from migrated content. They also update it as well, so we can sync when there are new unicode emoji lists released.

I've included a slimmed down and slightly modified forked copy of https://github.com/knq/emoji to make up our own emoji module. The code is pretty straight forward and again allows us to have a lot of flexibility in what happens.

I had seen a few comments about performance in some of the other threads if we render this ourselves, but there doesn't seem to be any issue here. In a test it can parse, convert, and render 1,000 emojis inside of a large markdown table in about 100ms on my laptop (which is many more emojis than will ever be in any normal issue). This also prevents any flickering and other weirdness from using javascript to render some things while using go for others.

Not included here are image fall back URLS. I don't really think they are necessary for anything new being written in 2020. However, managing the emoji ourselves would allow us to add these as a feature later on if it seems necessary.

Fixes: https://github.com/go-gitea/gitea/issues/9182
Fixes: https://github.com/go-gitea/gitea/issues/8974
Fixes: https://github.com/go-gitea/gitea/issues/8953
Fixes: https://github.com/go-gitea/gitea/issues/6628
Fixes: https://github.com/go-gitea/gitea/issues/5130

* add new shared function emojiHTML

* don't increase emoji size in issue title

* Update templates/repo/issue/view_content/add_reaction.tmpl

Co-Authored-By: 6543 <6543@obermui.de>

* Support for emoji rendering in various templates

* Render code and review comments as they should be

* Better way to handle mail subjects

* insert unicode from tribute selection

* Add template helper for plain text when needed

* Use existing replace function I forgot about

* Don't include emoji greater than Unicode Version 12

Only include emoji and aliases in JSON

* Update build/generate-emoji.go

* Tweak regex slightly to really match everything including random invisible characters. Run tests for every emoji we have

* final updates

* code review

* code review

* hard code gitea custom emoji to match previous behavior

* Update .eslintrc

Co-Authored-By: silverwind <me@silverwind.io>

* disable preempt

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>
2020-04-28 15:05:39 -03:00

8.4 KiB
Raw Blame History

date title slug url weight toc draft
2016-11-08T16:00:00+02:00 Documentation documentation /en-us/ 10 true false

What is Gitea?

Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. Gitea is a fork of Gogs. See the Gitea Announcement blog post to read about the justification for a fork.

Purpose

The goal of this project is to provide the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across all platforms and architectures that Go supports. This support includes Linux, macOS, and Windows, on architectures like amd64, i386, ARM, PowerPC, and others.

Features

  • User Dashboard
    • Context switcher (organization or current user)
    • Activity timeline
      • Commits
      • Issues
      • Pull requests
      • Repository creation
    • Searchable repository list
    • List of organizations
    • A list of mirror repositories
  • Issues dashboard
    • Context switcher (organization or current user)
    • Filter by
      • Open
      • Closed
      • Your repositories
      • Assigned issues
      • Your issues
      • Repository
    • Sort by
      • Oldest
      • Last updated
      • Number of comments
  • Pull request dashboard
    • Same as issue dashboard
  • Repository types
    • Mirror
    • Normal
    • Migrated
  • Notifications (email and web)
    • Read
    • Unread
    • Pin
  • Explore page
    • Users
    • Repos
    • Organizations
    • Search
  • Custom templates
  • Override public files (logo, css, etc)
  • CSRF and XSS protection
  • HTTPS support
  • Set allowed upload sizes and types
  • Logging
  • Configuration
    • Databases
      • MySQL
      • PostgreSQL
      • SQLite3
      • MSSQL
      • TiDB (experimental, not recommended)
    • Configuration file
    • Admin panel
      • Statistics
      • Actions
        • Delete inactive accounts
        • Delete cached repository archives
        • Delete repositories records which are missing their files
        • Run garbage collection on repositories
        • Rewrite SSH keys
        • Resync hooks
        • Recreate repositories which are missing
      • Server status
        • Uptime
        • Memory
        • Current # of goroutines
        • And more
      • User management
        • Search
        • Sort
        • Last login
        • Authentication source
        • Maximum repositories
        • Disable account
        • Admin permissions
        • Permission to create git hooks
        • Permission to create organizations
        • Permission to import repositories
      • Organization management
        • People
        • Teams
        • Avatar
        • Hooks
      • Repository management
        • See all repository information and manage repositories
      • Authentication sources
        • OAuth
        • PAM
        • LDAP
        • SMTP
      • Configuration viewer
        • Everything in config file
      • System notices
        • When somthing unexpected happens
      • Monitoring
        • Current processes
        • Cron jobs
          • Update mirrors
          • Repository health check
          • Check repository statistics
          • Clean up old archives
    • Environment variables
    • Command line options
  • Multi-language support (21 languages)
  • Mail service
    • Notifications
    • Registration confirmation
    • Password reset
  • Reverse proxy support
    • Includes subpaths
  • Users
    • Profile
      • Name
      • Username
      • Email
      • Website
      • Join date
      • Followers and following
      • Organizations
      • Repositories
      • Activity
      • Starred repositories
    • Settings
      • Same as profile and more below
      • Keep email private
      • Avatar
        • Gravatar
        • Libravatar
        • Custom
      • Password
      • Mutiple email addresses
      • SSH Keys
      • Connected applications
      • Two factor authentication
      • Linked OAuth2 sources
      • Delete account
  • Repositories
    • Clone with SSH/HTTP/HTTPS
    • Git LFS
    • Watch, Star, Fork
    • View watchers, stars, and forks
    • Code
      • Branch browser
      • Web based file upload and creation
      • Clone urls
      • Download
        • ZIP
        • TAR.GZ
      • Web based editor
        • Markdown editor
        • Plain text editor
          • Syntax highlighting
        • Diff preview
        • Preview
        • Choose where to commit to
      • View file history
      • Delete file
      • View raw
    • Issues
      • Issue templates
      • Milestones
      • Labels
      • Assign issues
      • Track time
      • Reactions
      • Filter
        • Open
        • Closed
        • Assigned person
        • Created by you
        • Mentioning you
      • Sort
        • Oldest
        • Last updated
        • Number of comments
      • Search
      • Comments
      • Attachments
    • Pull requests
      • Same features as issues
    • Commits
      • Commit graph
      • Commits by branch
      • Search
      • Search in all branches
      • View diff
      • View SHA
      • View author
      • Browse files in commit
    • Releases
      • Attachments
      • Title
      • Content
      • Delete
      • Mark as pre-release
      • Choose branch
    • Wiki
      • Import
      • Markdown editor
    • Settings
      • Options
        • Name
        • Description
        • Private/Public
        • Website
        • Wiki
          • Enabled/disabled
          • Internal/external
        • Issues
          • Enabled/disabled
          • Internal/external
          • External supports url rewriting for better integration
        • Enable/disable pull requests
        • Transfer repository
        • Delete wiki
        • Delete repository
      • Collaboration
        • Read/write/admin
      • Branches
        • Default branch
        • Branch protection
      • Webhooks
      • Git hooks
      • Deploy keys

System Requirements

  • A Raspberry Pi 3 is powerful enough to run Gitea for small workloads.
  • 2 CPU cores and 1GB RAM is typically sufficient for small teams/projects.
  • Gitea should be run with a dedicated non-root system account on UNIX-type systems.
    • Note: Gitea manages the ~/.ssh/authorized_keys file. Running Gitea as a regular user could break that user's ability to log in.
  • Git version 1.7.2 or later is required. Version 1.9.0 or later is recommended. Also please note:
    • Git large file storage will be available if enabled when git >= 2.1.2.
    • Git commit-graph rendering will be enabled automatically when git >= 2.18.

Browser Support

  • Please see Semantic UI for specific versions of supported browsers.

Components

Software and Service Support