mirrors/mostlymatter
1
0
Форкнуть 0
Код Задачи Запросы на слияние Действия Пакеты Проекты Релизы Вики Активность

Merge pull request #331 from mattermost/060-readme-updates

Просмотр исходного кода 
Updates to the README for release.
Этот коммит содержится в:
Christopher Speller
2015-08-05 12:13:25 -04:00
родитель 110a1e51a4 5e87875a13
Коммит a2d26be5df
1 изменённых файлов: 52 добавлений и 48 удалений
Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

100
README.md
Просмотреть файл

@@ -1,47 +1,47 @@
**Mattermost Alpha** **Mattermost Alpha**
**Team Communication Service** **Team Communication Service**
**Development Build** **Development Build**
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
Notes:
- For Alpha, Docker is intentionally setup as a single container, since production deployment not yet recommended.
Local Machine Setup (Docker) 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:helium`. 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
@@ -52,8 +52,13 @@ Local Machine Setup (Docker)
newgrp docker newgrp docker
``` ```
2. Run `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium` 2. Start docker container:
3. When docker is done fetching the image, open http://localhost:8065/ in your browser
``` 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.
### Arch ### ### Arch ###
1. Install docker using the following commands: 1. Install docker using the following commands:
@@ -69,39 +74,36 @@ Local Machine Setup (Docker)
2. Start docker container: 2. Start docker container:
``` bash ``` bash
docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium 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.
### Notes ### ### Additional Notes ###
If your ISP blocks port 25 then you may install locally but email will not be sent. - 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`
If you want to work with the latest bits in the repo you can run the cmd - You can update to the latest bits by running:
`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:latest` `docker pull mattermost/platform:dev`
You can update to the latest bits by running - If you wish to remove mattermost-dev use:
`docker pull mattermost/platform:latest` `docker stop mattermost-dev`
`docker rm -v mattermost-dev`
If you wish to remove mattermost-dev use the following commands - If you wish to gain access to a shell on the container use:
`docker exec -ti mattermost-dev /bin/bash`
1. `docker stop mattermost-dev`
2. `docker rm -v mattermost-dev`
If you wish to gain access to the container use the following commands
1. `docker exec -ti mattermost-dev /bin/bash`
AWS Elastic Beanstalk Setup (Docker) AWS Elastic Beanstalk Setup (Docker)
------------------------------------ ------------------------------------
1. Create a new elastic beanstalk docker application using the 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 and 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 docker. For environment type select single instance. 6. For predefined configuration select under Generic: Docker. For environment type select single instance.
7. For application source, select upload your own and upload Dockerrun.aws.json from docker/Dockerrun.aws.json. Everything else may be left at default. 7. For application source, select upload your own and upload Dockerrun.aws.json from [docker/0.6/Dockerrun.aws.json](docker/0.6/Dockerrun.aws.json). Everything else may be left at default.
8. Select an environment name, this is how you will refer to your environment. Make sure the URL is available then press next. 8. Select an environment name, this is how you will refer to your environment. Make sure the URL is available then press next.
9. The options on the additional resources page may be left at default unless you wish to change them. Press Next. 9. The options on the additional resources page may be left at default unless you wish to change them. Press Next.
10. On the configuration details place. Select an instance type of t2.small or larger. 10. On the configuration details place. Select an instance type of t2.small or larger.
@@ -111,22 +113,24 @@ AWS Elastic Beanstalk Setup (Docker)
4. Try it out! 4. Try it out!
14. Wait for beanstalk to update the environment. 14. Wait for beanstalk to update the environment.
15. Try it out by entering the domain of the form \*.elasticbeanstalk.com found at the top of the dashboard into your browser. You can also map your own domain if you wish. 15. Try it out by entering the domain of the form \*.elasticbeanstalk.com found at the top of the dashboard into your browser. You can also map your own domain if you wish.
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 or ./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.
* *ServiceSettings*:*StorageDirectory* - The file path where files will be stored locally if *UseLocalStorage* is set to true. The operating system user that is running the Mattermost application must have read and write privileges to this directory. * *ServiceSettings*:*StorageDirectory* - The file path where files will be stored locally if *UseLocalStorage* is set to true. The operating system user that is running the Mattermost application must have read and write privileges to this directory.
* *AWSSettings*:*S3*\* - If *UseLocalStorage* is set to false, and the S3 settings are configured here, then Mattermost will store files in the provided S3 bucket. * *AWSSettings*:*S3*\* - If *UseLocalStorage* is set to false, and the S3 settings are configured here, then Mattermost will store files in the provided S3 bucket.
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)
License License
------- -------