Changelog • Usage • License • Contributing
A customisable terminal-style website, intended to act as a portfolio.
The full changelog can be found at CHANGELOG.md
- Terminal style website
- Default commands including whoami, github, linkedin, email, clear, reset, help
- Heavily obfuscated email to avoid email scrapers
- Commands can be customised using
config.json, seeconfig.example.json - Custom commands defined in the same config
- Command completion with tab
- Command history with up/down arrow keys
- Deployable with Docker
- Clone the repository
- Copy
config.example.jsontoconfig.jsonand configure as you desire. Fields beginning with__commentdescribe the related non-comment field. - Run the container with Docker Compose
docker compose up -d --build. - The container will now be bound to
127.0.0.1:443using a self-signed certificate generated on first start-up. - You can now place the container behind a reverse proxy such as Nginx.
Bring your own cert
If you wish to use your own certificate instead of using a self-signed, that is possible.
The startup script nginx/5-ssl.sh checks for the presence of both:
/etc/ssl/personal-website/personal-website.key/etc/ssl/personal-website/personal-website.crt
Bind mount your cert and private key to these locations and Nginx will use your cert.
| Name | Description |
|---|---|
NGINX_SERVER_NAME |
Used in the Nginx configuration template to respond to the correct server name. By default will respond to all requests. For more information view the Nginx wiki |
- Clone the repository
- Copy
config.example.jsontoconfig.jsonand configure as you desire. Fields beginning with__commentdescribe the related non-comment field. - Install dependencies,
npm install - Deploy
dist/personal-website/browseranywhere you wish.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
See CONTRIBUTING.md.
Special thanks to m4tt72 for inspiring the design.