Run update.sh
This commit is contained in:
Docker Library Bot
parent
845a5d2ccc
commit
21c1ec5a00
|
|
@ -0,0 +1,158 @@
|
|||
# Supported tags and respective `Dockerfile` links
|
||||
|
||||
- [`0.2.2`, `latest` (*Dockerfile*)](https://github.com/nats-io/nats-streaming-docker/blob/d7e21255fec8967f7dbdacdb4501c8e78d821e49/Dockerfile)
|
||||
|
||||
For more information about this image and its history, please see [the relevant manifest file (`library/nats-streaming`)](https://github.com/docker-library/official-images/blob/master/library/nats-streaming). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fnats-streaming).
|
||||
|
||||
For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see [the `repos/nats-streaming/tag-details.md` file](https://github.com/docker-library/repo-info/blob/master/repos/nats-streaming/tag-details.md) in [the `docker-library/repo-info` GitHub repo](https://github.com/docker-library/repo-info).
|
||||
|
||||
# [NATS Streaming](https://nats.io): A high-performance cloud native messaging streaming system.
|
||||
|
||||
|
||||
|
||||
`nats-streaming` is a high performance streaming server for the NATS Messaging System.
|
||||
|
||||
# Example usage
|
||||
|
||||
```bash
|
||||
# Run a NATS Streaning server
|
||||
# Each server exposes multiple ports
|
||||
# 4222 is for clients.
|
||||
# 8222 is an HTTP management port for information reporting.
|
||||
# use -p or -P as needed.
|
||||
|
||||
$ docker run -d nats-streaming
|
||||
|
||||
Output that you would get if you had started with `-ti` instead of `d` (for daemon):
|
||||
|
||||
[INF] Starting nats-streaming-server[test-cluster] version 0.2.2
|
||||
[INF] Starting nats-server version 0.9.2
|
||||
[INF] Starting http monitor on :8222
|
||||
[INF] Listening for client connections on 0.0.0.0:4222
|
||||
[INF] Server is ready
|
||||
[INF] STAN: Message store is MEMORY
|
||||
[INF] STAN: Maximum of 1000000 will be stored
|
||||
|
||||
To use a file based store instead, you would run:
|
||||
|
||||
$ docker run -d nats-streaming -store file -dir datastore
|
||||
|
||||
[INF] Starting nats-streaming-server[test-cluster] version 0.2.2
|
||||
[INF] Starting nats-server version 0.9.2
|
||||
[INF] Starting http monitor on :8222
|
||||
[INF] Listening for client connections on 0.0.0.0:4222
|
||||
[INF] Server is ready
|
||||
[INF] STAN: Message store is FILE
|
||||
[INF] STAN: Maximum of 1000000 will be stored
|
||||
|
||||
You can also connect to a remote NATS Server running in a docker image.
|
||||
First, run NATS Server:
|
||||
|
||||
$ docker run -d --name=nats-main nats
|
||||
|
||||
Now, start the Streaming server and link it to the above docker image:
|
||||
|
||||
$ docker run -d --link nats-main nats-streaming -ns nats://nats-main:4222
|
||||
|
||||
[INF] Starting nats-streaming-server[test-cluster] version 0.2.2
|
||||
[INF] STAN: Message store is MEMORY
|
||||
[INF] STAN: Maximum of 1000000 will be stored
|
||||
|
||||
Notice that the output shows that the NATS Server was not started, as opposed to the first output.
|
||||
|
||||
```
|
||||
|
||||
# Commandline Options
|
||||
|
||||
```bash
|
||||
Streaming Server Options:
|
||||
-cid, --cluster_id <cluster ID> Cluster ID (default: test-cluster)
|
||||
-st, --store <type> Store type: MEMORY|FILE (default: MEMORY)
|
||||
--dir <directory> For FILE store type, this is the root directory
|
||||
-mc, --max_channels <number> Max number of channels (aka subjects, topics, etc...)
|
||||
-msu, --max_subs <number> Max number of subscriptions per channel
|
||||
-mm, --max_msgs <number> Max number of messages per channel
|
||||
-mb, --max_bytes <number> Max messages total size per channel
|
||||
-ns, --nats_server <url> Connect to this external NATS Server (embedded otherwise)
|
||||
|
||||
Streaming Server TLS Options:
|
||||
-secure Use a TLS connection to the NATS server without
|
||||
verification; weaker than specifying certificates.
|
||||
-tls_client_key Client key for the streaming server
|
||||
-tls_client_cert Client certificate for the streaming server
|
||||
-tls_client_cacert Client certificate CA for the streaming server
|
||||
|
||||
Streaming Server Logging Options:
|
||||
-SD, --stan_debug Enable STAN debugging output
|
||||
-SV, --stan_trace Trace the raw STAN protocol
|
||||
-SDV Debug and trace STAN
|
||||
(See additional NATS logging options below)
|
||||
|
||||
Embedded NATS Server Options:
|
||||
-a, --addr <host> Bind to host address (default: 0.0.0.0)
|
||||
-p, --port <port> Use port for clients (default: 4222)
|
||||
-P, --pid <file> File to store PID
|
||||
-m, --http_port <port> Use port for http monitoring
|
||||
-ms,--https_port <port> Use port for https monitoring
|
||||
-c, --config <file> Configuration file
|
||||
|
||||
Logging Options:
|
||||
-l, --log <file> File to redirect log output
|
||||
-T, --logtime Timestamp log entries (default: true)
|
||||
-s, --syslog Enable syslog as log method
|
||||
-r, --remote_syslog <addr> Syslog server addr (udp://localhost:514)
|
||||
-D, --debug Enable debugging output
|
||||
-V, --trace Trace the raw protocol
|
||||
-DV Debug and trace
|
||||
|
||||
Authorization Options:
|
||||
--user <user> User required for connections
|
||||
--pass <password> Password required for connections
|
||||
--auth <token> Authorization token required for connections
|
||||
|
||||
TLS Options:
|
||||
--tls Enable TLS, do not verify clients (default: false)
|
||||
--tlscert <file> Server certificate file
|
||||
--tlskey <file> Private key for server certificate
|
||||
--tlsverify Enable TLS, very client certificates
|
||||
--tlscacert <file> Client certificate CA for verification
|
||||
|
||||
NATS Clustering Options:
|
||||
--routes <rurl-1, rurl-2> Routes to solicit and connect
|
||||
--cluster <cluster-url> Cluster URL for solicited routes
|
||||
|
||||
Common Options:
|
||||
-h, --help Show this message
|
||||
-v, --version Show version
|
||||
--help_tls TLS help.
|
||||
```
|
||||
|
||||
# License
|
||||
|
||||
View [license information](https://github.com/nats-io/nats-streaming-server/blob/master/LICENSE) for the software contained in this image.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.1.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`nats-streaming/` directory](https://github.com/docker-library/docs/tree/master/nats-streaming) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/nats-io/nats-streaming-docker/issues). If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository first](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker).
|
||||
|
||||
You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/nats-io/nats-streaming-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
|
|
@ -55,6 +55,36 @@ Running Redmine with a database server is the recommened way.
|
|||
$ docker run -d --name some-redmine --link some-postgres:postgres redmine
|
||||
```
|
||||
|
||||
## ... via [`docker-compose`](https://github.com/docker/compose)
|
||||
|
||||
Example `docker-compose.yml` for `redmine`:
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
|
||||
redmine:
|
||||
image: redmine
|
||||
ports:
|
||||
- 8080:3000
|
||||
environment:
|
||||
REDMINE_DB_MYSQL: db
|
||||
REDMINE_DB_PASSWORD: example
|
||||
depends_on:
|
||||
- db
|
||||
restart: always
|
||||
|
||||
db:
|
||||
image: mariadb
|
||||
environment:
|
||||
MYSQL_ROOT_PASSWORD: example
|
||||
MYSQL_DATABASE: redmine
|
||||
restart: always
|
||||
```
|
||||
|
||||
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
|
||||
|
||||
## Alternative Web Server
|
||||
|
||||
The other tags in this repository, like those with `passenger`, use the same environment and `--links` as the default tags that use WEBrick (`rails s`) but instead give you the option of a different web and application server. `passenger` uses [Phusion Passenger](https://www.phusionpassenger.com/). [`tini`](https://github.com/krallin/tini) is used for reaping [zombies](https://en.wikipedia.org/wiki/Zombie_process).
|
||||
|
|
|
|||
Loading…
Reference in New Issue