Correcting minor typos, formatting, wording
Этот коммит содержится в:
49
README.md
49
README.md
@@ -6,23 +6,20 @@
|
|||||||
About Mattermost
|
About Mattermost
|
||||||
================
|
================
|
||||||
|
|
||||||
Mattermost is a team communication service. It brings team messaging and file sharing into one place, accessible across PCs and phones, with archiving and search.
|
Mattermost is an open-source team communication service. It brings team messaging and file sharing into one place, accessible across PCs and phones, with archiving and search.
|
||||||
|
|
||||||
We built Mattermost to help teams focus on what matters most to them. It works for us, we hope it works for you too.
|
|
||||||
|
|
||||||
Learn More
|
Learn More
|
||||||
==========
|
==========
|
||||||
<ul>
|
- Ask the core team anything at: http://forum.mattermost.org
|
||||||
<li/>Ask the core team anything at: http://forum.mattermost.org</li>
|
- Share feature requests and upvotes: http://www.mattermost.org/feature-requests/
|
||||||
<li/>Share feature requests and upvotes: http://www.mattermost.org/feature-requests/</li>
|
- File bugs: http://www.mattermost.org/filing-issues/
|
||||||
<li/>File bugs: http://www.mattermost.org/filing-issues/</li>
|
- Make a pull request: http://www.mattermost.org/contribute-to-mattermost/
|
||||||
<li/>Make a pull request: http://www.mattermost.org/contribute-to-mattermost/</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
Installing Mattermost
|
Installing Mattermost
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
You're installing "Mattermost Alpha", a pre-released version intended for an early look at what we're building. While SpinPunch runs this version internally, it's not recommended for production deployments since we can't guarantee API stability or backwards compatibility until our production release.
|
You're installing "Mattermost Alpha", a pre-released version providing an early look at what we're building. While the core team runs this version internally, it's not recommended for production since we can't guarantee API stability or backwards compatibility.
|
||||||
|
|
||||||
That said, any issues at all, please let us know on the Mattermost forum at: http://forum.mattermost.org
|
That said, any issues at all, please let us know on the Mattermost forum at: http://forum.mattermost.org
|
||||||
|
|
||||||
@@ -34,17 +31,17 @@ Local Machine Setup (Docker)
|
|||||||
|
|
||||||
### Mac OSX ###
|
### Mac OSX ###
|
||||||
|
|
||||||
1. Follow the instructions at http://docs.docker.com/installation/mac/
|
1. Follow the instructions at: http://docs.docker.com/installation/mac/
|
||||||
1. Use the Boot2Docker command-line utility
|
1. Use the Boot2Docker command-line utility.
|
||||||
2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
|
2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
|
||||||
2. Get your Docker IP address with `boot2docker ip`
|
2. Get your Docker IP address with: `boot2docker ip`
|
||||||
3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost`
|
3. Add a line to your /etc/hosts that goes: `<Docker IP> dockerhost`
|
||||||
4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash\_profile
|
4. Run: `boot2docker shellinit` and copy the export statements to your ~/.bash\_profile.
|
||||||
5. Run `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`.
|
5. Run: `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`
|
||||||
6. When docker is done fetching the image, open http://dockerhost:8065/ in your browser
|
6. When docker is done fetching the image, open http://dockerhost:8065/ in your browser.
|
||||||
|
|
||||||
### Ubuntu ###
|
### Ubuntu ###
|
||||||
1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below.
|
1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below:
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
@@ -57,9 +54,11 @@ Local Machine Setup (Docker)
|
|||||||
|
|
||||||
2. Start docker container:
|
2. Start docker container:
|
||||||
|
|
||||||
`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`
|
``` bash
|
||||||
|
docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform
|
||||||
|
```
|
||||||
|
|
||||||
3. When docker is done fetching the image, open http://localhost:8065/ in your browser
|
3. When docker is done fetching the image, open http://localhost:8065/ in your browser.
|
||||||
|
|
||||||
### Arch ###
|
### Arch ###
|
||||||
1. Install docker using the following commands:
|
1. Install docker using the following commands:
|
||||||
@@ -81,7 +80,7 @@ Local Machine Setup (Docker)
|
|||||||
3. When docker is done fetching the image, open http://localhost:8065/ in your browser.
|
3. When docker is done fetching the image, open http://localhost:8065/ in your browser.
|
||||||
|
|
||||||
### Additional Notes ###
|
### Additional Notes ###
|
||||||
- If you want to work with the latest bits in the repository (i.e. not a stable release) you can run the cmd
|
- If you want to work with the latest bits in the repository (i.e. not a stable release) you can run the cmd:
|
||||||
`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:dev`
|
`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:dev`
|
||||||
|
|
||||||
- You can update to the latest bits by running:
|
- You can update to the latest bits by running:
|
||||||
@@ -98,9 +97,9 @@ AWS Elastic Beanstalk Setup (Docker)
|
|||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
1. Create a new elastic beanstalk docker application using the [Dockerrun.aws.json](docker/0.6/Dockerrun.aws.json) file provided.
|
1. Create a new elastic beanstalk docker application using the [Dockerrun.aws.json](docker/0.6/Dockerrun.aws.json) file provided.
|
||||||
1. From the AWS console select Elastic Beanstalk
|
1. From the AWS console select Elastic Beanstalk.
|
||||||
2. Select "Create New Application" from the top right.
|
2. Select "Create New Application" from the top right.
|
||||||
3. Name the application and press next
|
3. Name the application and press next.
|
||||||
4. Select "Create a web server" environment.
|
4. Select "Create a web server" environment.
|
||||||
5. If asked, select create an IAM role and instance profile and press next.
|
5. If asked, select create an IAM role and instance profile and press next.
|
||||||
6. For predefined configuration select under Generic: Docker. For environment type select single instance.
|
6. For predefined configuration select under Generic: Docker. For environment type select single instance.
|
||||||
@@ -119,7 +118,7 @@ AWS Elastic Beanstalk Setup (Docker)
|
|||||||
Configuration Settings
|
Configuration Settings
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in [config/config.json](config/config.json) or [docker/0.6/config_docker.json](docker/0.6/config_docker.json) /config/config/config\_docker.json if you're running a docker instance.
|
There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in [config/config.json](config/config.json) or [docker/0.6/config_docker.json](docker/0.6/config_docker.json) if you're running a docker instance.
|
||||||
|
|
||||||
* *EmailSettings*:*ByPassEmail* - If this is set to true, then users on the system will not need to verify their email addresses when signing up. In addition, no emails will ever be sent.
|
* *EmailSettings*:*ByPassEmail* - If this is set to true, then users on the system will not need to verify their email addresses when signing up. In addition, no emails will ever be sent.
|
||||||
* *ServiceSettings*:*UseLocalStorage* - If this is set to true, then your Mattermost server will store uploaded files in the storage directory specified by *StorageDirectory*. *StorageDirectory* must be set if *UseLocalStorage* is set to true.
|
* *ServiceSettings*:*UseLocalStorage* - If this is set to true, then your Mattermost server will store uploaded files in the storage directory specified by *StorageDirectory*. *StorageDirectory* must be set if *UseLocalStorage* is set to true.
|
||||||
@@ -129,7 +128,7 @@ There are a few configuration settings you might want to adjust when setting up
|
|||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
To contribute to this open source project please review the Mattermost Contribution Guidelines at http://www.mattermost.org/contribute-to-mattermost/.
|
To contribute to this open source project please review the [Mattermost Contribution Guidelines]( http://www.mattermost.org/contribute-to-mattermost/).
|
||||||
|
|
||||||
To setup your machine for development of mattermost see: [Developer Machine Setup](scripts/README_DEV.md)
|
To setup your machine for development of mattermost see: [Developer Machine Setup](scripts/README_DEV.md)
|
||||||
|
|
||||||
|
|||||||
Ссылка в новой задаче
Block a user