Skip to content

Commit

Permalink
Merge pull request #585 from pierreozoux/known
Browse files Browse the repository at this point in the history
Adds known
  • Loading branch information
yosifkit authored Dec 7, 2016
2 parents dd848b3 + 817ab3c commit 5f09885
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions known/README-short.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Blogging, meet social. Known is a social publishing platform.
50 changes: 50 additions & 0 deletions known/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Known: social publishing for groups and individuals

Blogging, meet social.

Known is a social publishing platform. Publish on your own site, reach your audience across social media.

%%LOGO%%

# How to use this image

```bash
docker run --link some-mysql:db -d known
```

Now you can get access to fpm running on port 9000 inside the container. If you want to access it from the Internets, we recommend using a reverse proxy in front. You can find more information on that on the [docker-compose](#docker-compose) section.

The following environment variables are also honored for configuring your Known instance:

- `-e KNOWN_DB_HOST=...` (defaults to the IP and port of the linked `mysql` container)
- `-e KNOWN_DB_USER=...` (defaults to "root")
- `-e KNOWN_DB_PASSWORD=...` (defaults to the value of the `MYSQL_ROOT_PASSWORD` environment variable from the linked `mysql` container)
- `-e KNOWN_DB_NAME=...` (defaults to "known")
- `-e MAIL_HOST=...`
- `-e MAIL_PORT=...`
- `-e MAIL_SECURE=...` ("starttls" for instance)
- `-e MAIL_USER=...`
- `-e MAIL_PASS=...`

If the `KNOWN_DB_NAME` specified does not already exist on the given MySQL server, it will be created automatically upon startup of the `%%REPO%%` container, provided that the `KNOWN_DB_USER` specified has the necessary permissions to create it.

If you'd like to use an external database instead of a linked `mysql` container, specify the hostname and port with `KNOWN_DB_HOST` along with the password in `KNOWN_DB_PASSWORD` and the username in `KNOWN_DB_USER` (if it is something other than `root`):

```console
$ docker run --name some-%%REPO%% -e KNOWN_DB_HOST=10.1.2.3:3306 \
-e KNOWN_DB_USER=... -e KNOWN_DB_PASSWORD=... -d %%REPO%%
```

## Via docker-compose

You can use a setup that is used in production at [IndieHosters/known](https://github.com/indiehosters/known).

## Installation

Once started, you'll arrive at the configuration wizard. Follow the steps as indicated.

## Contribute

Pull requests are very welcome!

We'd love to hear your feedback and suggestions in the issue tracker: [github.com/idno/Known-docker/issues](https://github.com/idno/Known-docker/issues).
1 change: 1 addition & 0 deletions known/github-repo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://github.com/idno/Known-Docker
1 change: 1 addition & 0 deletions known/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
View [license information](https://raw.githubusercontent.com/idno/Known/master/LICENSE) for the software contained in this image.
Binary file added known/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5f09885

Please sign in to comment.