<<<<<<< HEAD

• Docker is an open source project to pack, ship and run any Linux application in a lighter weight, faster container than a traditional virtual machine.

• Docker makes it much easier to deploy a Discourse forum on your servers and keep it updated. For background, see Sam's blog post.

• The templates and base image configure Discourse with the Discourse team's recommended optimal defaults.

The simplest way to get started is via the standalone template, which can be installed in 30 minutes or less. For detailed install instructions, see

https://github.com/discourse/discourse/blob/main/docs/INSTALL-cloud.md

Contains container ids for currently running Docker containers. cids are Docker's "equivalent" of pids. Each container will have a unique git like hash.

This directory is for container definitions for your various Discourse containers. You are in charge of this directory, it ships empty.

Sample container definitions you may use to bootstrap your environment. You can copy templates from here into the containers directory.

Placeholder spot for shared volumes with various Discourse containers. You may elect to store certain persistent information outside of a container, in our case we keep various logfiles and upload directory outside. This allows you to rebuild containers easily without losing important information. Keeping uploads outside of the container allows you to share them between multiple web instances.

pups-managed templates you may use to bootstrap your environment.

Dockerfiles for Discourse; see the README for further details.

The Docker repository will always contain the latest built version at: https://hub.docker.com/r/discourse/base/, you should not need to build the base image.

The base directory contains a single bash script which is used to manage containers. You can use it to "bootstrap" a new container, enter, start, stop and destroy a container.

Usage: launcher COMMAND CONFIG [--skip-prereqs] [--docker-args STRING]
Commands:
    start:       Start/initialize a container
    stop:        Stop a running container
    restart:     Restart a container
    destroy:     Stop and remove a container
    enter:       Open a shell to run commands inside the container
    logs:        View the Docker logs for a container
    bootstrap:   Bootstrap a container for the config based on a template
    run:         Run the given command with the config in the context of the last bootstrapped image
    rebuild:     Rebuild a container (destroy old, bootstrap, start new)
    cleanup:     Remove all containers that have stopped for > 24 hours
    start-cmd:   Generate docker command used to start container

If the environment variable "SUPERVISED" is set to true, the container won't be detached, allowing a process monitoring tool to manage the restart behaviour of the container.

The beginning of the container definition can contain the following "special" sections:

templates:
  - 'templates/cron.template.yml'
  - 'templates/postgres.template.yml'

This template is "composed" out of all these child templates, this allows for a very flexible configuration structure. Furthermore you may add specific hooks that extend the templates you reference.

expose:
  - '2222:22'
  - '127.0.0.1:20080:80'

Publish port 22 inside the container on port 2222 on ALL local host interfaces. In order to bind to only one interface, you may specify the host's IP address as ([<host_interface>:[host_port]])|(<host_port>):<container_port>[/udp] as defined in the docker port binding documentation. To expose a port without publishing it, specify only the port number (e.g., 80).

volumes:
  - volume:
    host: /var/discourse/shared
    guest: /shared

Expose a directory inside the host to the container.

links:
  - link:
    name: postgres
    alias: postgres

Links another container to the current container. This will add --link postgres:postgres to the options when running the container.

Setting environment variables to the current container.

env:
  DISCOURSE_DB_HOST: some-host
  DISCOURSE_DB_NAME: '{{config}}_discourse'

The above will add -e DISCOURSE_DB_HOST=some-host -e DISCOURSE_DB_NAME=app_discourse to the options when running the container.

labels:
  monitor: 'true'
  app_name: '{{config}}_discourse'

Add labels to the current container. The above will add --l monitor=true -l app_name=dev_discourse to the options when running the container

The Docker setup gives you multiple upgrade options:

1. Use the front end at http://yoursite.com/admin/upgrade to upgrade an already running image.

2. Create a new base image manually by running: ./launcher rebuild my_image

The samples directory contains a standalone template. This template bundles all of the software required to run Discourse into a single container. The advantage is that it is easy.

The multiple container configuration setup is far more flexible and robust, however it is also more complicated to set up. A multiple container setup allows you to:

• Minimize downtime when upgrading to new versions of Discourse. You can bootstrap new web processes while your site is running and only after it is built, switch the new image in.
• Scale your forum to multiple servers.
• Add servers for redundancy.
• Have some required services (e.g. the database) run on beefier hardware.

If you want a multiple container setup, see the data.yml and web_only.yml templates in the samples directory. To ease this process, launcher will inject an env var called DISCOURSE_HOST_IP which will be available inside the image.

WARNING: In a multiple container configuration, make sure you setup iptables or some other firewall to protect various ports (for postgres/redis). On Ubuntu, install the ufw or iptables-persistent package to manage firewall rules.

For a Discourse instance to function properly Email must be set up. Use the SMTP_URL env var to set your SMTP address, see sample templates for an example. The Docker image does not contain postfix, exim or another MTA, it was omitted because it is very tricky to set up correctly.

View the container logs: ./launcher logs my_container

Spawn a shell inside your container using ./launcher enter my_container. This is the most foolproof method if you have host root access.

If you see network errors trying to retrieve code from github.com or rubygems.org try again - sometimes there are temporary interruptions and a retry is all it takes.

Behind a proxy network with no direct access to the Internet? Add proxy information to the container environment by adding to the existing env block in the container.yml file:

env:
  …existing entries…
  HTTP_PROXY: http://proxyserver:port/
  http_proxy: http://proxyserver:port/
  HTTPS_PROXY: http://proxyserver:port/
  https_proxy: http://proxyserver:port/

Directory permissions in Linux are UID/GID based, if your numeric IDs on the host do not match the IDs in the guest, permissions will mismatch. On clean installs you can ensure they are in sync by looking at /etc/passwd and /etc/group, the Discourse account will have UID 1000.

• Setting up SSL with Discourse Docker
• Multisite configuration with Docker
• Linking containers for a multiple container setup
• Using Rubygems mirror to improve connection problem in China

Discourse is the online home for your community. We offer a 100% open source community platform to those who want complete control over how and where their site is run.

Our platform has been battle-tested for over a decade and continues to evolve to meet users’ needs for a powerful community platform. Discourse allows you to create discussion topics and connect using real-time chat, as well as access an ever-growing number of official and community themes. In addition, we offer a wide variety of plugins for features ranging from chatbots powered by Discourse AI to functionalities like SQL analysis using the Data Explorer plugin.

To learn more, visit discourse.org and join our support community at meta.discourse.org.

Browse lots more notable Discourse instances.

To get your environment set up, 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.
4. If you're looking to use a simpler Docker-based install, try the Docker 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 3.2+, PostgreSQL 13, Redis 7. If you're having trouble, please see our TROUBLESHOOTING GUIDE first!

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

If you're looking for official hosting, see discourse.org/pricing.

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

Discourse supports the latest, stable releases of all major browsers and platforms:

Additionally, we aim to support Safari on iOS 15.7+.

• 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.
• BrowserStack — We use BrowserStack to test on real devices and browsers.

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

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!

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 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 - 2023 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.

To guide our ongoing effort to build accessible software we follow the W3C’s Web Content Accessibility Guidelines (WCAG). If you'd like to report an accessibility issue that makes it difficult for you to use Discourse, email [email protected]. For more information visit discourse.org/accessibility.

Discourse is built with love, Internet style.

origin/main