Skip to content

Commit 7c82101

Browse files
jaydrogersjaydrogers
committed
Update README.md for improved clarity and formatting
- Adjusted table formatting for Docker image and size for better readability. - Clarified the description of the `REPLACE_SYMLINKS` environment variable to indicate its requirement for Windows. - Enhanced the layout of contributor information for better presentation. Co-authored-by: Jay Rogers <[email protected]>
1 parent c248913 commit 7c82101

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

‎README.md‎

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313

1414
This container is used to generate and automatically renew SSL certificates from Let's Encrypt using the Cloudflare DNS plugin. It's based off the [official Certbot image](https://hub.docker.com/r/certbot/dns-cloudflare) with some modifications to make it more flexible and configurable.
1515

16-
| Docker Image | Size |
17-
|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18-
| [**serversideup/certbot-dns-cloudflare**](https://hub.docker.com/r/serversideup/certbot-dns-cloudflare) | [![Docker Image Size](https://img.shields.io/docker/image-size/serversideup/certbot-dns-cloudflare/latest?style=flat-square)](https://hub.docker.com/r/serversideup/certbot-dns-cloudflare) |
16+
| Docker Image | Size |
17+
|-------------|------|
18+
| [serversideup/certbot-dns-cloudflare](https://hub.docker.com/r/serversideup/certbot-dns-cloudflare) | ![Docker Image Size](https://img.shields.io/docker/image-size/serversideup/certbot-dns-cloudflare/latest?style=flat-square) |
1919

2020
## Base Image
2121

@@ -41,7 +41,7 @@ The following environment variables can be used to customize the Certbot contain
4141
| `CERTBOT_KEY_TYPE` | Type of private key to generate | `ecdsa` |
4242
| `CLOUDFLARE_API_TOKEN` | Cloudflare API token for DNS authentication | - |
4343
| `RENEWAL_INTERVAL` | Interval between certificate renewal checks | 43200 seconds (12 hours) |
44-
| `REPLACE_SYMLINKS` | Replaces symlinks with direct copies of the files they reference | `false` |
44+
| `REPLACE_SYMLINKS` | Replaces symlinks with direct copies of the files they reference (required for Windows) | `false` |
4545

4646
## Usage
4747

@@ -122,9 +122,30 @@ We're [Dan](https://twitter.com/danpastori) and [Jay](https://twitter.com/jaydro
122122
123123
<div style="text-align: center">
124124
125-
| <div align="center">Dan Pastori</div> | <div align="center">Jay Rogers</div> |
126-
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
127-
| <div align="center"><a href="https://twitter.com/danpastori"><img src="https://serversideup.net/wp-content/uploads/2023/08/dan.jpg" title="Dan Pastori" width="150px"></a><br /><a href="https://twitter.com/danpastori"><img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/twitter.svg" title="Twitter" width="24px"></a><a href="https://github.com/danpastori"><img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/github.svg" title="GitHub" width="24px"></a></div> | <div align="center"><a href="https://twitter.com/jaydrogers"><img src="https://serversideup.net/wp-content/uploads/2023/08/jay.jpg" title="Jay Rogers" width="150px"></a><br /><a href="https://twitter.com/jaydrogers"><img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/twitter.svg" title="Twitter" width="24px"></a><a href="https://github.com/jaydrogers"><img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/github.svg" title="GitHub" width="24px"></a></div> |
125+
| <div align="center">Dan Pastori</div> | <div align="center">Jay Rogers</div> |
126+
|---------------------------------------|-------------------------------------|
127+
| <div align="center">
128+
<a href="https://twitter.com/danpastori">
129+
<img src="https://serversideup.net/wp-content/uploads/2023/08/dan.jpg" title="Dan Pastori" width="150px">
130+
</a><br />
131+
<a href="https://twitter.com/danpastori">
132+
<img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/twitter.svg" title="Twitter" width="24px">
133+
</a>
134+
<a href="https://github.com/danpastori">
135+
<img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/github.svg" title="GitHub" width="24px">
136+
</a>
137+
</div> |
138+
<div align="center">
139+
<a href="https://twitter.com/jaydrogers">
140+
<img src="https://serversideup.net/wp-content/uploads/2023/08/jay.jpg" title="Jay Rogers" width="150px">
141+
</a><br />
142+
<a href="https://twitter.com/jaydrogers">
143+
<img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/twitter.svg" title="Twitter" width="24px">
144+
</a>
145+
<a href="https://github.com/jaydrogers">
146+
<img src="https://serversideup.net/wp-content/themes/serversideup/images/open-source/github.svg" title="GitHub" width="24px">
147+
</a>
148+
</div> |
128149
129150
</div>
130151

0 commit comments

Comments
 (0)