Interpreting and recovering from license expiry and error messages
Is the server not working because of a license error, or is your API key being rejected? Bareun authenticates with
a license file (closed network) or an API key (cloud), depending on where you use it. Use this document to interpret the message and
recover.
Symptoms
- A license expiry or error message appears when the server starts or handles a request.
- The API key is rejected or authentication fails.
- You see errors related to
license.pemin a closed-network (on-premises) install.
Causes
Diagnosis is easier once you understand that the authentication path differs by environment.
| Environment | Authentication method |
|---|---|
Cloud (api.bareun.ai) | API key (koba-XXXX-...), port 443, TLS |
| Closed-network (on-premises) install | License file license.pem |
| Cause | Description |
|---|---|
| License expired | The validity period of license.pem has passed |
| License file missing or wrong path | license.pem cannot be found on the closed network |
| API key error | The key is wrong or in the wrong format |
| Free tier exceeded | Exceeded the cloud free limit of 50,000 eojeol (space-delimited word units) |
Solution
-
First, identify which environment you are in. For the cloud, the API key is the key to authentication, and for a closed-network install,
license.pemis. -
Closed network: check
license.pem. Check that the license file is in the expected location and within its validity period. Check against a setup where the file sits in thevardirectory (for example,${BAREUN_ROOT}/var/license.pem). If it has expired, you need to replace it with a renewed license. -
Cloud: check the API key. The key format starts with
koba-. You register a key through the registration API (-reg) or the API key registration screen of the built-in web. Check that the key is correct and that it was passed properly to your environment settings. -
Check whether you have exceeded the free tier. The free tier of cloud morphological analysis is 50,000 eojeol. If you have exceeded it, you need to switch to a paid plan.
The spell checker is cloud-only
The spell checker is a cloud-only paid feature. To use it on a closed network, a separate paid installation is required. Morphological analysis is free for research and non-commercial use, and paid for commercial use.
Prevention and tips
- If you run on a closed network, write the expiry date of
license.pemon a calendar in advance and renew with time to spare. - Keep the API key safe so it is not exposed, and inject it through environment variables or a secure store.
Frequently asked questions
Q. I get a license error on a closed network. What should I look at?
Check that the license.pem file is in the expected location and within its validity period. It is usually placed in the var directory, such as
${BAREUN_ROOT}/var/license.pem. If it has expired, you need to replace it with a renewed license.
Q. My API key is rejected in the cloud.
Check that the key format starts with koba- and that you entered it correctly. You can register a key through the registration API (-reg) or the
API key registration screen of the built-in web. Also check whether you have exceeded the free tier (50,000 eojeol).
Q. Can I use the spell checker on a closed network?
The spell checker is a cloud-only paid feature. To use it on a closed network, a separate paid installation is required.
Q. What message appears when I exceed the free tier?
The free tier of cloud morphological analysis is 50,000 eojeol. Once you go over the limit, rejections related to authentication or usage may occur. If you have exceeded it, you need to switch to a paid plan. If your API key is correct but requests are still rejected, also check whether you have exceeded the free tier.