Doorgaan naar de website
OCLC Support

BOM and EZproxy text files

Applies to

  • EZproxy

Answer

A byte-order mark, or BOM, is a short marker placed at the very beginning of a text file. In UTF-8, it consists of three bytes: EF BB BF. UTF-8 does not need this marker, so it is optional. Some text editors add it when saving a file.

EZproxy reads files such as config.txt, user.txt, and shibuser.txt as instructions. If a file begins with a BOM, the marker may be read as part of the first line rather than ignored. That could make the first directive—or a first-line comment—look different from what an administrator intended. A BOM on a comment line might therefore not be harmless.

OCLC’s documentation describes directives in config.txt and rules in shibuser.txt, but does not specify whether EZproxy removes a UTF-8 BOM from these files before processing them. Because behavior is not documented, saving the file without a BOM is a simple precaution against potential parsing problems.

Save these files as UTF-8 without BOM. This recommendation is the same whether EZproxy runs on Linux or Windows: the BOM is stored in the file itself, not added by the operating system. If you suspect a file has a BOM, resave it in UTF-8 without BOM and then follow the normal EZproxy procedure for applying changes.

Page ID

70579