Преглед изворни кода

manual and changelog updates for #563

tags/v1.1.0
Shivaram Lingamneni пре 5 година
родитељ
комит
29b1dd37a8
2 измењених фајлова са 10 додато и 3 уклоњено
  1. 7
    3
      CHANGELOG.md
  2. 3
    0
      docs/MANUAL.md

+ 7
- 3
CHANGELOG.md Прегледај датотеку

10
 * Support for the newly ratified [message tags](https://ircv3.net/specs/extensions/message-tags.html) and [message ID](https://ircv3.net/specs/extensions/message-ids.html) IRCv3 specifications; client developers are invited to use Oragono as a reference when implementing these specifications.
10
 * Support for the newly ratified [message tags](https://ircv3.net/specs/extensions/message-tags.html) and [message ID](https://ircv3.net/specs/extensions/message-ids.html) IRCv3 specifications; client developers are invited to use Oragono as a reference when implementing these specifications.
11
 * Support for running Oragono as a Tor hidden service.
11
 * Support for running Oragono as a Tor hidden service.
12
 
12
 
13
+### Upgrade notes
14
+
13
 This release includes a database change. If you have `datastore.autoupgrade` set to `true` in your configuration, it will be automatically applied when you restart Oragono; otherwise, you can update the database manually by running `oragono upgradedb`.
15
 This release includes a database change. If you have `datastore.autoupgrade` set to `true` in your configuration, it will be automatically applied when you restart Oragono; otherwise, you can update the database manually by running `oragono upgradedb`.
14
 
16
 
17
+No changes to your configuration file should be required for this upgrade; however, updating the file is necessary to enable some new functionality, as described below.
18
+
15
 ### Config changes
19
 ### Config changes
16
 * `tor-listeners` section added for configuring listeners for use with Tor.
20
 * `tor-listeners` section added for configuring listeners for use with Tor.
17
 * `compatibility` section added for toggling compatibility behaviors for legacy clients.
21
 * `compatibility` section added for toggling compatibility behaviors for legacy clients.
18
 * `ip-cloaking` section added for configuring cloaking.
22
 * `ip-cloaking` section added for configuring cloaking.
19
 * `bouncer` section added for configuring bouncer-like features (in particular, whether multiple clients can use the same nickname).
23
 * `bouncer` section added for configuring bouncer-like features (in particular, whether multiple clients can use the same nickname).
20
-* `check-ident` now defaults to `false`.
21
-* `nick-reservation.method` now defaults to `"strict"`.
22
-* `fakelag.enabled` now defaults to `true`
24
+* `check-ident` now has recommended value `false`.
25
+* `nick-reservation.method` now has recommended value "strict"`.
26
+* `fakelag.enabled` now has recommended value `true`.
23
 * `limits.linelen.tags` removed due to ratification of the [message-tags spec](https://ircv3.net/specs/extensions/message-tags.html), which fixes the maximum tags length at 8191 bytes.
27
 * `limits.linelen.tags` removed due to ratification of the [message-tags spec](https://ircv3.net/specs/extensions/message-tags.html), which fixes the maximum tags length at 8191 bytes.
24
 * `limits.registration-messages` added to restrict how many messages a user can send to the server during connection registration (while connecting to the server).
28
 * `limits.registration-messages` added to restrict how many messages a user can send to the server during connection registration (while connecting to the server).
25
 * `channels.operator-only-creation` added to optionally restrict creation of new channels to ircops (#537).
29
 * `channels.operator-only-creation` added to optionally restrict creation of new channels to ircops (#537).

+ 3
- 0
docs/MANUAL.md Прегледај датотеку

22
 - Installing
22
 - Installing
23
     - Windows
23
     - Windows
24
     - macOS / Linux / Raspberry Pi
24
     - macOS / Linux / Raspberry Pi
25
+    - Upgrading
25
 - Features
26
 - Features
26
     - User Accounts
27
     - User Accounts
27
         - Nickname reservation
28
         - Nickname reservation
135
 
136
 
136
 As long as you are using official releases or release candidates of Oragono, any backwards-incompatible changes should be described in the changelog.
137
 As long as you are using official releases or release candidates of Oragono, any backwards-incompatible changes should be described in the changelog.
137
 
138
 
139
+In general, the config file format should be fully backwards and forwards compatible. Unless otherwise noted, no config file changes should be necessary when upgrading Oragono. However, the "config changes" section of the changelog will typically describe new sections that can be added to your config to enable new functionality, as well as changes in the recommended values of certain fields.
140
+
138
 The database is versioned; upgrades that involve incompatible changes to the database require updating the database. If you have `datastore.autoupgrade` enabled in your config, the database will be backed up and upgraded when you restart your server when required. Otherwise, you can apply upgrades manually:
141
 The database is versioned; upgrades that involve incompatible changes to the database require updating the database. If you have `datastore.autoupgrade` enabled in your config, the database will be backed up and upgraded when you restart your server when required. Otherwise, you can apply upgrades manually:
139
 
142
 
140
 1. Stop your server
143
 1. Stop your server

Loading…
Откажи
Сачувај