# Is there a nice GH badges (ala shields.io images) design to put in README to link from GitHub to our hosted discourse?

**URL:** https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105
**Category:** Feature
**Created:** [June 26, 2017, 4:09am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105 "2017-06-26T04:09:25Z")
**Posts on this page:** 18
**Page:** 1

<div class="post-metadata">

### Author: ![chakrit](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/chakrit/32/120486_2.png) [@chakrit](https://meta.discourse.org/u/chakrit)
#### Post date: [June 26, 2017, 4:09am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/1 "2017-06-26T04:09:25Z")

</div>

As the title says.

I am looking for something like these:

 ![](https://global.discourse-cdn.com/meta/original/3X/1/c/1c8906890b2d6edbb760996b8ad3d2d0b1485f91.png)

…but for discourse. Is there one?

---

<div class="post-metadata">

### Author: ![codinghorror](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/codinghorror/32/110067_2.png) [@codinghorror](https://meta.discourse.org/u/codinghorror)
#### Post date: [June 26, 2017, 4:52am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/2 "2017-06-26T04:52:05Z")

</div>

Let’s see if @erlend_sh has ideas here?

---

<div class="post-metadata">

### Author: ![johnmuhl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/johnmuhl/32/43413_2.png) [@johnmuhl](https://meta.discourse.org/u/johnmuhl)
#### Post date: [June 26, 2017, 5:12am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/3 "2017-06-26T05:12:55Z")

</div>

[shields.io](http://shields.io) allows you to create custom badges; e.g.

> **[discourse: forum](https://img.shields.io/badge/discourse-forum-brightgreen.svg?style=flat-square)**

---

<div class="post-metadata">

### Author: ![erlend\_sh](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/erlend_sh/32/119475_2.png) [@erlend\_sh](https://meta.discourse.org/u/erlend_sh)
#### Post date: [June 27, 2017, 3:36pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/4 "2017-06-27T15:36:04Z")

</div>

Feel free to investigate how to get Discourse added to the official [shields.io](http://shields.io) listing:

> <https://github.com/badges/shields/blob/master/CONTRIBUTING.md>

No need for any API interaction; it should be static.

---

<div class="post-metadata">

### Author: ![chakrit](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/chakrit/32/120486_2.png) [@chakrit](https://meta.discourse.org/u/chakrit)
#### Post date: [June 28, 2017, 6:55am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/5 "2017-06-28T06:55:07Z")

</div>

Thanks! Will see what I what I can help w adding an official badge.

Meanwhile I think this will work nicely:

![](https://global.discourse-cdn.com/meta/original/3X/9/7/97a29a66b7cc810e0d97e431718513a0da062ed0.svg)

```plaintext
![](//cdck-file-uploads-global.s3.dualstack.us-west-2.amazonaws.com/meta/original/3X/9/7/97a29a66b7cc810e0d97e431718513a0da062ed0.svg)

```

---

<div class="post-metadata">

### Author: ![coderberry](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/coderberry/32/99652_2.png) [@coderberry](https://meta.discourse.org/u/coderberry)
#### Post date: [November 29, 2017, 4:16am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/6 "2017-11-29T04:16:11Z")

</div>

Without API interaction, there is no need for having it appear on [shields.io](http://shields.io).

Here’s the markdown code that should work:

```plaintext
[![Discourse](https://img.shields.io/badge/discourse-online-green.svg)](https://meta.discourse.com)

```

The rendered results look like this:

![](https://global.discourse-cdn.com/meta/original/3X/5/c/5c53268bcfd6783890cb7d9dfa872ac4bf1c5eb5.png)

The verbiage can be changed in the svg URL (e.g. `discourse-online-green.svg` could be `discourse-forum-blue.svg`)

---

<div class="post-metadata">

### Author: ![sam](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/sam/32/102149_2.png) [@sam](https://meta.discourse.org/u/sam)
#### Post date: [November 29, 2017, 5:58am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/7 "2017-11-29T05:58:11Z")

</div>

Before this though we need to get travis into a much happier state, it is still way too flaky. Some tests need love. I did see a random segfault yesterday on travis not sure how we would recover from that and keep the build green.

---

<div class="post-metadata">

### Author: ![coderberry](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/coderberry/32/99652_2.png) [@coderberry](https://meta.discourse.org/u/coderberry)
#### Post date: [November 29, 2017, 12:28pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/8 "2017-11-29T12:28:21Z")

</div>

Is there an API endpoint that will tell us the current state of the app? I ask because it seems that Travis only represents latest master right? I wonder if this badge needs to indicate latest master status or the status of their own instance.

---

<div class="post-metadata">

### Author: ![johnmuhl](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/johnmuhl/32/43413_2.png) [@johnmuhl](https://meta.discourse.org/u/johnmuhl)
#### Post date: [November 29, 2017, 1:13pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/9 "2017-11-29T13:13:56Z")

</div>

What does this have to do with the status of travis? The OP just wanted some flair to put in the readme of their project (a “click here to join our forum” type button). I fail to see why that would have to include the build status of `discourse/discourse`.

Related to the travis flakiness. Have y’all considered CircleCI? It is not 100% without fault but it is considerably more stable than travis.

---

<div class="post-metadata">

### Author: ![Falco](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/falco/32/179432_2.png) [@Falco](https://meta.discourse.org/u/Falco)
#### Post date: [November 29, 2017, 1:30pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/10 "2017-11-29T13:30:34Z")

</div>

> [@coderberry](#):
>
> Is there an API endpoint that will tell us the current state of the app?

[https://meta.discourse.org/srv/status](https://meta.discourse.org/srv/status) will give you 200 when the app is up and operational.

[https://meta.discourse.org/site/statistics.json](https://meta.discourse.org/site/statistics.json) will give you basic information that can be useful in a badge, like, number of posts in the last 7/30 days (which is kinda of equivalent to online users in a async communication platform like Discourse)

---

<div class="post-metadata">

### Author: ![coderberry](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/coderberry/32/99652_2.png) [@coderberry](https://meta.discourse.org/u/coderberry)
#### Post date: [November 30, 2017, 4:24pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/11 "2017-11-30T16:24:59Z")

</div>

This is ideal. With the [https://discuss.emberjs.com/srv/status](https://discuss.emberjs.com/srv/status) page (visible for all installs), having it exist on [shields.io](http://shields.io) would make sense.

I’ll go ahead with this and create a PR

---

<div class="post-metadata">

### Author: ![coderberry](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/coderberry/32/99652_2.png) [@coderberry](https://meta.discourse.org/u/coderberry)
#### Post date: [December 4, 2017, 9:24pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/12 "2017-12-04T21:24:16Z")

</div>

I submitted a PR to badges/shields

 ![15 PM](https://global.discourse-cdn.com/meta/original/3X/1/2/12b765b9bfd90b17cbbe8630538f000dac84a834.jpg)

[https://github.com/badges/shields/pull/1326](https://github.com/badges/shields/pull/1326)

---

<div class="post-metadata">

### Author: ![sam](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/sam/32/102149_2.png) [@sam](https://meta.discourse.org/u/sam)
#### Post date: [December 4, 2017, 9:25pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/13 "2017-12-04T21:25:46Z")

</div>

Nice, I think the “users” one carries the most weight if you have good number of users!

---

<div class="post-metadata">

### Author: ![coderberry](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/coderberry/32/99652_2.png) [@coderberry](https://meta.discourse.org/u/coderberry)
#### Post date: [December 5, 2017, 3:57pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/14 "2017-12-05T15:57:48Z")

</div>

@sam Do you know if there are many discourse hosts in the wild that are not using https? My PR to shields assumes they all are. This is likely a poor assumption.

---

<div class="post-metadata">

### Author: ![Falco](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/falco/32/179432_2.png) [@Falco](https://meta.discourse.org/u/Falco)
#### Post date: [December 5, 2017, 5:25pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/15 "2017-12-05T17:25:35Z")

</div>

If the HTTP request library that [shields.io](http://shields.io) use handles redirects, you can set it to http and it will work for http and https.

If not, defaulting to https only should be good enough. We do everything in the `discourse-setup` script to make it as easy as possible.

---

<div class="post-metadata">

### Author: ![coderberry](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/coderberry/32/99652_2.png) [@coderberry](https://meta.discourse.org/u/coderberry)
#### Post date: [December 5, 2017, 5:53pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/16 "2017-12-05T17:53:12Z")

</div>

Perfect. Thanks @Falco!

---

<div class="post-metadata">

### Author: ![chakrit](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/chakrit/32/120486_2.png) [@chakrit](https://meta.discourse.org/u/chakrit)
#### Post date: [December 6, 2017, 4:51am UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/17 "2017-12-06T04:51:01Z")

</div>

Wow, you guys rock! Thanks @coderberry !

---

<div class="post-metadata">

### Author: ![haikalpribadi](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/haikalpribadi/32/112126_2.png) [@haikalpribadi](https://meta.discourse.org/u/haikalpribadi)
#### Post date: [September 13, 2019, 3:35pm UTC](https://meta.discourse.org/t/is-there-a-nice-gh-badges-ala-shields-io-images-design-to-put-in-readme-to-link-from-github-to-our-hosted-discourse/65105/18 "2019-09-13T15:35:48Z")

</div>

Would anyone know why it shows as `invalid` for us?

[![Discussion Forum](https://global.discourse-cdn.com/meta/original/3X/5/e/5ed9e8058dc6f612ad909d989e1277eb91e09e71.svg)](https://discuss.grakn.ai)  
[https://img.shields.io/discourse/https/discuss.grakn.ai/topics](https://img.shields.io/discourse/https/discuss.grakn.ai/topics)

Meanwhile, you can see that [https://discuss.grakn.ai](https://discuss.grakn.ai) is live. 🤔
