wassname/talk
1
0
Fork 0
mirror of https://github.com/wassname/talk.git synced 2026-08-12 12:30:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed docs

Browse Source
This commit is contained in:
Wyatt Johnson
2018-02-20 11:34:26 -07:00
parent 4c06d5659d
commit 22ee7b1d34
4 changed files with 97 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_config.yml
-8
View File
@@ -131,14 +131,6 @@ sidebar:
- title: Migrating to v4.1.0
url: /migration/4.1/
versions:
node: 8+
yarn: 1.3.2+
mongodb: 3.2+
redis: 3.2.5+
docker: 17.06.2+
docker_compose: 1.14.0+
marked:
gfm: true
pedantic: false
docs/source/01-01-talk-quickstart.md
+54 -6
View File
@@ -17,21 +17,21 @@ dependencies managed by
[Redis](https://redis.io/topics/quickstart) databases in order
to persist data. The following versions are supported:
- Node {{ config.versions.node }}
- Yarn {{ config.versions.yarn }}
- MongoDB {{ config.versions.mongodb }}
- Redis {{ config.versions.redis }}
- Node 8+
- Yarn 1.3.2+
- MongoDB 3.2+
- Redis 3.2.5+
An optional dependency for Talk is
[Docker](https://www.docker.com/community-edition#/download).
It is used during [development](#development) to set up the database and can be
used to [install via Docker](#installation-from-docker). We have tested Talk
and this documentation with versions {{ config.versions.docker }}.
and this documentation with versions 17.06.2+.
Another optional dependency for Talk is
[Docker Compose](https://docs.docker.com/compose/install/). It
can be used to setup your environment easily for testing. We have tested Talk
and this documentation with versions {{ config.versions.docker_compose }}.
and this documentation with versions 1.14.0+.
## Installation
@@ -42,7 +42,41 @@ provided docker image. The following is a `docker-compose.yml` file that can
be used to setup Talk:
```yml
# For details on the syntax of docker-compose.yml files, check out:
# https://docs.docker.com/compose/compose-file/compose-file-v2/
version: '2'
services:
talk:
image: coralproject/talk:latest
restart: always
ports:
- "3000:3000"
depends_on:
- mongo
- redis
environment:
- NODE_ENV=development # remove this line in production
- TALK_MONGO_URL=mongodb://mongo/talk
- TALK_REDIS_URL=redis://redis
- TALK_ROOT_URL=http://127.0.0.1:3000
- TALK_PORT=3000
- TALK_JWT_SECRET=password
mongo:
image: mongo:latest
restart: always
volumes:
- mongo:/data/db
redis:
image: redis:latest
restart: always
volumes:
- redis:/data
volumes:
mongo:
external: false
redis:
external: false
```
This is the bare minimum needed to run the demo, for more configuration
@@ -176,6 +210,20 @@ Talk. To demonstrate what your own self-hosted copy of Talk can do, below
you'll find a demo that can be used to test the copy that is running now on your
machine.
In order for the demo to work, you must add
`https://coralproject.github.io/` to your
permitted domains list. You can do this by visiting
[http://127.0.0.1:3000/admin/configure](http://127.0.0.1:3000/admin/configure)
now and selecting *Tech Settings* from the sidebar.
Once you have added the domain of these docs, you can click the button below.
<div class="demo">
<button id="talk-demo-embed-button" type="button" class="btn btn-block btn-coral">Start Demo</button>
<div class="alert" role="alert"></div>
<div class="mount"></div>
</div>
At this point you've successfully installed, configured, and ran your very own
instance of Talk! Continue through this documentation on this site to learn more
on how to configure, develop with, and contribute to Talk!
docs/source/01-02-installation-from-docker.md
+37 -2
View File
@@ -3,8 +3,8 @@ title: Installation from Docker
permalink: /installation-from-docker/
---
[Docker](https://www.docker.com/community-edition#/download) {{ site.versions.docker }} and
[Docker Compose](https://docs.docker.com/compose/install/) {{ site.versions.docker_compose }} are required
[Docker](https://www.docker.com/community-edition#/download) 17.06.2+ and
[Docker Compose](https://docs.docker.com/compose/install/) 1.14.0+ are required
to perform installation via Docker. This is the recommended way to deploy the
application when used in production.
@@ -37,6 +37,41 @@ provided docker image. The following is a `docker-compose.yml` file that can
be used to setup Talk:
```yml
# For details on the syntax of docker-compose.yml files, check out:
# https://docs.docker.com/compose/compose-file/compose-file-v2/
version: '2'
services:
talk:
image: coralproject/talk:latest
restart: always
ports:
- "3000:3000"
depends_on:
- mongo
- redis
environment:
- NODE_ENV=development # remove this line in production
- TALK_MONGO_URL=mongodb://mongo/talk
- TALK_REDIS_URL=redis://redis
- TALK_ROOT_URL=http://127.0.0.1:3000
- TALK_PORT=3000
- TALK_JWT_SECRET=password
mongo:
image: mongo:latest
restart: always
volumes:
- mongo:/data/db
redis:
image: redis:latest
restart: always
volumes:
- redis:/data
volumes:
mongo:
external: false
redis:
external: false
```
This is the bare minimum needed to start Talk, for more configuration
docs/source/01-03-installation-from-source.md
+6 -7
View File
@@ -3,13 +3,12 @@ title: Installation from Source
permalink: /installation-from-source/
---
To install Talk from Source, ensure that you have Node version
{{ site.versions.node }}. Installing via source is the recommended method when
developing as it give you the best tooling. We release versions using semantic
versioning, and do so to our
[Github Releases](https://github.com/coralproject/talk/releases)
page. There you can download archives of older versions or the latest release.
The examples following will download the latest code on our master branch.
To install Talk from Source, ensure that you have Node version 8+.
Installing via source is the recommended method when developing as it give you
the best tooling. We release versions using semantic versioning, and do so to
our [Github Releases](https://github.com/coralproject/talk/releases) page.
There you can download archives of older versions or the latest release. The
examples following will download the latest code on our master branch.
## Installing