Skip to content

Commit

Permalink
Allow multiple website entries for CORS
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
dormant-user committed Jan 15, 2024
1 parent 0212676 commit 7215884
Show file tree
Hide file tree
Showing 10 changed files with 43 additions and 31 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ if __name__ == '__main__':
```

### Env Variables
> :bulb: &nbsp; Environment variables can be loaded from any file. _Defaults to `.env`_<br>
> Set the env var `env_file` to the filename to use custom `.env` files
> :bulb: &nbsp; Environment variables can be loaded from any file. _Filename defaults to `.env`_<br>
> To use custom filenames, set the env var `env_file` as `key` and the _filename_ as its `value`
**Mandatory**
- **USERNAME**: Any username of choice.
Expand All @@ -46,7 +46,7 @@ if __name__ == '__main__':
- **VIDEO_PORT**: Port number to host the application. Defaults to `8000`
- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)`
- **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1`
- **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_
- **WEBSITE**: List of websites (_supports regex_) to add to CORS configuration. _Required only if tunneled via CDN_
- **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True`

## Coding Standards
Expand Down
6 changes: 3 additions & 3 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ <h2>Sample Usage<a class="headerlink" href="#sample-usage" title="Permalink to t
<section id="env-variables">
<h3>Env Variables<a class="headerlink" href="#env-variables" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>:bulb:   Environment variables can be loaded from any file. <em>Defaults to <code class="docutils literal notranslate"><span class="pre">.env</span></code></em><br>
Set the env var <code class="docutils literal notranslate"><span class="pre">env_file</span></code> to the filename to use custom <code class="docutils literal notranslate"><span class="pre">.env</span></code> files</p>
<div><p>:bulb:   Environment variables can be loaded from any file. <em>Filename defaults to <code class="docutils literal notranslate"><span class="pre">.env</span></code></em><br>
To use custom filenames, set the env var <code class="docutils literal notranslate"><span class="pre">env_file</span></code> as <code class="docutils literal notranslate"><span class="pre">key</span></code> and the <em>filename</em> as its <code class="docutils literal notranslate"><span class="pre">value</span></code></p>
</div></blockquote>
<p><strong>Mandatory</strong></p>
<ul class="simple">
Expand All @@ -94,7 +94,7 @@ <h3>Env Variables<a class="headerlink" href="#env-variables" title="Permalink to
<li><p><strong>VIDEO_PORT</strong>: Port number to host the application. Defaults to <code class="docutils literal notranslate"><span class="pre">8000</span></code></p></li>
<li><p><strong>FILE_FORMATS</strong>: Sequence of supported video file formats. Defaults to <code class="docutils literal notranslate"><span class="pre">(.mp4,</span> <span class="pre">.mov)</span></code></p></li>
<li><p><strong>WORKERS</strong>: Number of workers to spin up the <code class="docutils literal notranslate"><span class="pre">uvicorn</span></code> server. Defaults to <code class="docutils literal notranslate"><span class="pre">1</span></code></p></li>
<li><p><strong>WEBSITE</strong>: Website to add to CORS configuration. <em>Required only if tunneled via CDN</em></p></li>
<li><p><strong>WEBSITE</strong>: List of websites (<em>supports regex</em>) to add to CORS configuration. <em>Required only if tunneled via CDN</em></p></li>
<li><p><strong>AUTO_THUMBNAIL</strong>: Boolean flag to auto generate thumbnail images for preview. Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code></p></li>
</ul>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ if __name__ == '__main__':
```

### Env Variables
> :bulb: &nbsp; Environment variables can be loaded from any file. _Defaults to `.env`_<br>
> Set the env var `env_file` to the filename to use custom `.env` files
> :bulb: &nbsp; Environment variables can be loaded from any file. _Filename defaults to `.env`_<br>
> To use custom filenames, set the env var `env_file` as `key` and the _filename_ as its `value`
**Mandatory**
- **USERNAME**: Any username of choice.
Expand All @@ -46,7 +46,7 @@ if __name__ == '__main__':
- **VIDEO_PORT**: Port number to host the application. Defaults to `8000`
- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)`
- **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1`
- **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_
- **WEBSITE**: List of websites (_supports regex_) to add to CORS configuration. _Required only if tunneled via CDN_
- **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True`

## Coding Standards
Expand Down
6 changes: 3 additions & 3 deletions docs/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ if __name__ == '__main__':
```

### Env Variables
> :bulb: &nbsp; Environment variables can be loaded from any file. _Defaults to `.env`_<br>
> Set the env var `env_file` to the filename to use custom `.env` files
> :bulb: &nbsp; Environment variables can be loaded from any file. _Filename defaults to `.env`_<br>
> To use custom filenames, set the env var `env_file` as `key` and the _filename_ as its `value`

**Mandatory**
- **USERNAME**: Any username of choice.
Expand All @@ -46,7 +46,7 @@ if __name__ == '__main__':
- **VIDEO_PORT**: Port number to host the application. Defaults to `8000`
- **FILE_FORMATS**: Sequence of supported video file formats. Defaults to `(.mp4, .mov)`
- **WORKERS**: Number of workers to spin up the `uvicorn` server. Defaults to `1`
- **WEBSITE**: Website to add to CORS configuration. _Required only if tunneled via CDN_
- **WEBSITE**: List of websites (_supports regex_) to add to CORS configuration. _Required only if tunneled via CDN_
- **AUTO_THUMBNAIL**: Boolean flag to auto generate thumbnail images for preview. Defaults to `True`

## Coding Standards
Expand Down
6 changes: 4 additions & 2 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,8 @@ <h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#pystream.models.config.EnvConfig.parse_video_host">parse_video_host() (pystream.models.config.EnvConfig class method)</a>
</li>
<li><a href="index.html#pystream.models.config.EnvConfig.parse_website">parse_website() (pystream.models.config.EnvConfig class method)</a>
</li>
<li><a href="index.html#pystream.models.config.EnvConfig.password">password (pystream.models.config.EnvConfig attribute)</a>
</li>
Expand Down Expand Up @@ -260,15 +262,15 @@ <h2 id="P">P</h2>
<li><a href="index.html#module-pystream.models.config">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
pystream.models.images

<ul>
<li><a href="index.html#module-pystream.models.images">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
pystream.models.squire

Expand Down
Loading

0 comments on commit 7215884

Please sign in to comment.