# Updog

### Installation

```bash
pip3 install updog

updog [-d DIRECTORY] [-p PORT] [--password PASSWORD] [--ssl]
```

### Usage

| Argument                            | Description                                      |
| ----------------------------------- | ------------------------------------------------ |
| -d DIRECTORY, --directory DIRECTORY | Root directory \[Default=.]                      |
| -p PORT, --port PORT                | Port to serve \[Default=9090]                    |
| --password PASSWORD                 | Use a password to access the page. (No username) |
| --ssl                               | Enable transport encryption via SSL              |
| --version                           | Show version                                     |
| -h, --help                          | Show help                                        |

### Examples

```bash
# Serve from your current directory:**

updog

# Serve from another directory:

updog -d /another/directory

# Serve from port 1234:**

updog -p 1234

# Password protect the page:

updog --password examplePassword123!

#*Please note*: updog uses HTTP basic authentication.
#To login, you should leave the username blank and just
#enter the password in the password field.

# Use an SSL connection:

updog --ssl
```