Selaa lähdekoodia

Some notes on upgrading to 1.0

tags/1.0^2
9seconds 6 vuotta sitten
vanhempi
commit
24137b6ea2
1 muutettua tiedostoa jossa 18 lisäystä ja 1 poistoa
  1. 18
    1
      README.md

+ 18
- 1
README.md Näytä tiedosto

6
 [![Go Report Card](https://goreportcard.com/badge/github.com/9seconds/mtg)](https://goreportcard.com/report/github.com/9seconds/mtg)
6
 [![Go Report Card](https://goreportcard.com/badge/github.com/9seconds/mtg)](https://goreportcard.com/report/github.com/9seconds/mtg)
7
 [![Docker Build Status](https://img.shields.io/docker/build/nineseconds/mtg.svg)](https://hub.docker.com/r/nineseconds/mtg/)
7
 [![Docker Build Status](https://img.shields.io/docker/build/nineseconds/mtg.svg)](https://hub.docker.com/r/nineseconds/mtg/)
8
 
8
 
9
+**Please see a guide on upgrading to 1.0 at the end of this README.**
10
+
9
 # Rationale
11
 # Rationale
10
 
12
 
11
 There are several available proxies for Telegram MTPROTO available. Here
13
 There are several available proxies for Telegram MTPROTO available. Here
238
 | `crashes`                        | number  | An amount of crashes in client handlers                   |
240
 | `crashes`                        | number  | An amount of crashes in client handlers                   |
239
 | `traffic.ingress`                | bytes   | Ingress traffic from the start of application (incoming)  |
241
 | `traffic.ingress`                | bytes   | Ingress traffic from the start of application (incoming)  |
240
 | `traffic.egress`                 | bytes   | Egress traffic from the start of application (outgoing)   |
242
 | `traffic.egress`                 | bytes   | Egress traffic from the start of application (outgoing)   |
241
-| `replay_attacks`                 | number  | A number of prevented replay attacks.                     |
243
+| `replay_attacks`                 | number  | The number of prevented replay attacks.                   |
242
 
244
 
243
 All metrics are prefixed with given prefix. Default prefix is `mtg`.
245
 All metrics are prefixed with given prefix. Default prefix is `mtg`.
244
 With such prefix metric name `traffic.ingress`, for example, would be
246
 With such prefix metric name `traffic.ingress`, for example, would be
249
 
251
 
250
 [Prometheus](https://prometheus.io) integration comes out of
252
 [Prometheus](https://prometheus.io) integration comes out of
251
 the box, you do not need to setup anything special.
253
 the box, you do not need to setup anything special.
254
+
255
+
256
+# Upgrade to 1.0
257
+
258
+Version 1.0 breaks compatibility with previous versions so please read
259
+this chapter carefully:
260
+
261
+1. mtg now uses subcommands. Please use `mtg run` instead of just `mtg` to run
262
+   a proxy.
263
+2. Options which set host and port separately were removed in a favor of fused
264
+   host:port options.
265
+3. Own stats server was removed. Prometheus endpoint is moved to default stats
266
+   endpoint.
267
+4. It is possible to connect to this proxy only with a secret which was used to
268
+   run it. So, no backward compatibility of clients.

Loading…
Peruuta
Tallenna