> For the complete documentation index, see [llms.txt](https://docs.akamas.io/akamas-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akamas.io/akamas-docs/installing/docker/install-the-akamas-server/setup-https-configuration.md).

# Setup HTTPS configuration

Akamas Studio APIs and UI use plain HTTP when they are first installed. To enable the use of HTTPS you will need to:

1. Ask your security team to provide you with a valid certificate for your server.\
   The certificate usually consists of two files with ".key" and ".pem" extensions.\
   You will need to provide the Akamas Studio server DNS name.
2. Create a folder named "certs" in the same directory as Akamas Studio' docker-compose file;
3. Copy the ".key" and ".pem" files in the created "certs" folder and rename them to "akamas.key" and "akamas.pem" respectively.\
   Ensure the files belong to the same user and group you use to run Akamas Studio.
4. Restart two Akamas Studio services by running the following commands:

   ```bash
   cd <Akamas docker-compose file folder>
   docker compose restart akamas-ui kong
   ```

After the containers' reboot is complete you will be able to access the UI over HTTPS from your browser:

```
https://<akamas server name here>
```

If you previously set up AKAMAS\_BASE\_URL variable with http (e.g. `http://my.domain`) you should update it to use https (e.g. `http://my.domain`) then issue

```bash
docker compose up -d
```

### Setup CLI to use HTTPS

Now that your Akamas Studio server is configured to use HTTPS you can update the Akamas CLI configuration to use the secure protocol.

If you have not installed the Akamas Studio CLI, follow the [CLI installation guide](/akamas-docs/installing/install-the-akamas-cli.md). If you already have the CLI available, you can run the following command:

```bash
akamas init config
```

You will be prompted to enter some input, please value it as follows:

```
Api address [http://localhost:8000]: https://<akamas server dns address>:443/akapi
Workspace [default]: default
Verify SSL: [True]: True
```

You can test the connection by running:

```bash
akamas status
```

It should return 'OK', meaning Akamas Studio has been properly configured to work over HTTPS.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.akamas.io/akamas-docs/installing/docker/install-the-akamas-server/setup-https-configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.