Kelder/feathermost
32
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity

Improve README

Browse source
This commit is contained in:
Midgard 2021-09-15 14:37:55 +02:00
parent 4322f824ff
commit 5acd0a6760
Signed by: midgard
GPG key ID: 511C112F1331BBB4
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,5 +1,13 @@
# ![](./assets/feathermost.svg) Feathermost # ![](./assets/feathermost.svg) Feathermost
Before you can use Feathermost, the admin of your Mattermost servers must set up CORS
appropriately. If this is not possible, you can use a CORS puncturing proxy, such as the mitmproxy
setup provided for development (see below).
## Development
Dependencies: none.
To run in development mode, execute `rundev.sh`. To run in development mode, execute `rundev.sh`.
This will start a web server, and mitmproxy to avoid CORS problems. This will start a web server, and mitmproxy to avoid CORS problems.
Dependencies for that: Bash, Python and [`mitmproxy`](https://mitmproxy.org/). Dependencies for that: Bash, Python and [`mitmproxy`](https://mitmproxy.org/).