A platform for community discussion. Free, open, simple.
Go to file
David Taylor 0e303c7f5d
FEATURE: Automatically generate optimized site metadata icons (#7372)
This change automatically resizes icons for various purposes. Admins can now upload `logo` and `logo_small`, and everything else will be auto-generated. Specific icons can still be uploaded separately if required.

## Core

- Adds an SiteIconManager module which manages automatic resizing and fallback

- Icons are looked up in the OptimizedImage table at runtime, and then cached in Redis. If the resized version is missing for some reason, then most icons will fall back to the original files. Some icons (e.g. PWA Manifest) will return `nil` (because an incorrectly sized icon is worse than a missing icon). 

- `SiteSetting.site_large_icon_url` will return the optimized version, including any fallback. `SiteSetting.large_icon` continues to return the upload object. This means that (almost) no changes are required in core/plugins to support this new system.

- Icons are resized whenever a relevant site setting is changed, and during post-deploy migrations

## Wizard

- Allows `requiresRefresh` wizard steps to reload data via AJAX instead of a full page reload

- Add placeholders to the **icons** step of the wizard, which automatically update from the "Square Logo"

- Various copy updates to support the changes

- Remove the "upload-time" resizing for `large_icon`. This is no longer required.

## Site Settings UX

- Move logo/icon settings under a new "Branding" tab

- Various copy changes to support the changes

- Adds placeholder support to the `image-uploader` component

- Automatically reloads site settings after saving. This allows setting placeholders to change based on changes to other settings

- Upload site settings will be assigned a placeholder if SiteIconManager `responds_to?` an icon of the same name

## Dashboard Warnings

- Remove PWA icon and PWA title warnings. Both are now handled automatically.

## Bonus

- Updated the sketch logos to use @awesomerobot's new high-res designs
2019-05-01 14:44:45 +01:00
.tx Add Hungarian locale (#6260) 2018-08-13 01:02:35 +02:00
app FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
bin FEATURE: always update docker image for dev prior to launching 2019-02-18 13:12:00 +11:00
config FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
db FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
docs updated link for mailjet account & setup (#7312) 2019-04-03 16:48:17 +11:00
images fix image location 2014-09-11 17:56:29 +10:00
lib FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
log Initial release of Discourse 2013-02-05 14:16:51 -05:00
packaging/debian Fix .pkgr.yml so that discourse can be packaged with https://pkgr.io. 2014-03-26 15:08:53 +00:00
plugins FEATURE: adds support for dates in polls (#7450) 2019-04-29 10:01:19 +02:00
public FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
script FIX: cache_critical_dns was never caching pg replica (#7461) 2019-04-30 08:42:51 +08:00
spec FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
test FEATURE: Automatically generate optimized site metadata icons (#7372) 2019-05-01 14:44:45 +01:00
vendor DEV: jquery 3.4.0 2019-04-26 15:01:26 +02:00
.codeclimate.yml FEATURE: Replace composer editor with ember version 2015-11-06 09:49:16 -05:00
.editorconfig Set trim_trailing_whitespace false for markdown 2016-06-25 22:29:01 +04:30
.env.sample Basic Heroku integration 2013-03-13 19:07:49 +00:00
.eslintignore DEV: Yarn-manage moment and moment-timezone libraries 2019-02-12 13:57:52 -05:00
.eslintrc FIX: `expandAllPinned` was not resetting after visiting a category 2019-01-14 13:02:25 -05:00
.gitattributes Use proper encoding for email fixtures. 2018-02-21 17:06:35 +08:00
.gitignore DEV: Add vagrant directory to gitignore 2019-03-28 12:55:46 -04:00
.overcommit.yml DEV: Run bundler and yarn and check YAML files in overcommit hooks 2018-09-27 04:57:37 +02:00
.pkgr.yml Fix .pkgr.yml so that discourse can be packaged with https://pkgr.io. 2014-03-26 15:08:53 +00:00
.prettierignore DEV: unpin Prettier version, apply to YAML files 2019-01-17 13:05:39 -05:00
.rspec DEV: Use `--profile` and `--fail-fast` in CI only 2019-03-11 22:04:47 -04:00
.rspec_parallel DEV: Introduce parallel rspec testing 2019-04-01 11:06:47 -04:00
.rubocop.yml Update Rubocop to 0.60 2018-12-04 10:48:16 +01:00
.ruby-gemset.sample rvm has offically depreicated .rvmrc and recommends using .ruby-version and .ruby-gemset instead. 2013-05-23 09:16:11 -07:00
.ruby-version.sample Update to latest Ruby release 2018-11-28 10:20:03 +11:00
.travis.yml DEV: Only install danger on Travis. (#7452) 2019-04-29 14:45:24 +08:00
Brewfile FIX: brewfile was out of date 2018-03-01 10:15:37 +01:00
CONTRIBUTING.md Proper long form for CLA 2015-09-10 20:49:03 +02:00
COPYRIGHT.txt fix trademark 2013-06-27 09:38:15 +10:00
Dangerfile DEV: more precise self pattern check (#7278) 2019-03-29 08:50:18 +01:00
Gemfile Bump onebox version 2019-04-30 10:07:48 -03:00
Gemfile.lock Bump onebox version 2019-04-30 10:07:48 -03:00
LICENSE.txt Initial release of Discourse 2013-02-05 14:16:51 -05:00
README.md Browser version bump 2019-03-25 17:11:18 -04:00
Rakefile Add rubocop to our build. (#5004) 2017-07-28 10:20:09 +09:00
adminjs Initial release of Discourse 2013-02-05 14:16:51 -05:00
config.ru FEATURE: allow plugins to easily detect if running in Rack 2017-11-16 08:39:29 +11:00
d add wrappers for mailcatcher and sidekiq 2016-12-13 09:05:45 +11:00
discourse.sublime-project DEV: Exclude i18n .yml files from Sublime Text project. (#6473) 2018-10-10 20:21:24 +08:00
jsapp Initial release of Discourse 2013-02-05 14:16:51 -05:00
package.json DEV: jquery 3.4.0 2019-04-26 15:01:26 +02:00
yarn.lock DEV: jquery 3.4.0 2019-04-26 15:01:26 +02:00

README.md

Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:

  • mailing list
  • discussion forum
  • long-form chat room

To learn more about the philosophy and goals of the project, visit discourse.org.

Screenshots

Boing Boing

Mobile

Browse lots more notable Discourse instances.

Development

To get your environment setup, follow the community setup guide for your operating system.

  1. If you're on macOS, try the macOS development guide.
  2. If you're on Ubuntu, try the Ubuntu development guide.
  3. If you're on Windows, try the Windows 10 development guide.

If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the Discourse Advanced Developer Guide, which is aimed primarily at Ubuntu and macOS environments.

Before you get started, ensure you have the following minimum versions: Ruby 2.5+, PostgreSQL 10+, Redis 2.6+. If you're having trouble, please see our TROUBLESHOOTING GUIDE first!

Setting up Discourse

If you want to set up a Discourse forum for production use, see our Discourse Install Guide.

If you're looking for business class hosting, see discourse.org/buy.

Requirements

Discourse is built for the next 10 years of the Internet, so our requirements are high:

Browsers Tablets Phones
Safari 10+ iPad 4+ iOS 10+
Google Chrome 57+ Android 4.4+ Android 4.4+
Internet Explorer 11+
Firefox 52+

Built With

  • Ruby on Rails — Our back end API is a Rails app. It responds to requests RESTfully in JSON.
  • Ember.js — Our front end is an Ember.js app that communicates with the Rails API.
  • PostgreSQL — Our main data store is in Postgres.
  • Redis — We use Redis as a cache and for transient data.

Plus lots of Ruby Gems, a complete list of which is at /master/Gemfile.

Contributing

Build Status

Discourse is 100% free and open source. We encourage and support an active, healthy community that accepts contributions from the public including you!

Before contributing to Discourse:

  1. Please read the complete mission statements on discourse.org. Yes we actually believe this stuff; you should too.
  2. Read and sign the Electronic Discourse Forums Contribution License Agreement.
  3. Dig into CONTRIBUTING.MD, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
  4. Always strive to collaborate with mutual respect.
  5. Not sure what to work on? We've got some ideas.

We look forward to seeing your pull requests!

Security

We take security very seriously at Discourse; all our code is 100% open source and peer reviewed. Please read our security guide for an overview of security measures in Discourse, or if you wish to report a security issue.

The Discourse Team

The original Discourse code contributors can be found in AUTHORS.MD. For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official Discourse blog and GitHub's list of contributors.

Copyright 2014 - 2019 Civilized Discourse Construction Kit, Inc.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.

Dedication

Discourse is built with love, Internet style.