diff options
| -rw-r--r-- | index.md | 2 | ||||
| -rw-r--r-- | publish.md | 30 | ||||
| -rw-r--r-- | start.md | 67 |
3 files changed, 77 insertions, 22 deletions
@@ -31,7 +31,7 @@ Happy to chat.[1] PS: -[How to get a username on compost.party](/username.html) +[How to get started on compost.party](/start.html) [How to publish a site on compost.party](/publish.html) @@ -20,7 +20,13 @@ then edit that file using the text editor nano, for example: $ nano index.md -Type some text. +Type some text, for example: + + # This is the title of my page. + + some text. + + [a link](https://compost.party). Save. @@ -57,24 +63,20 @@ You can copy mine if you want: color: pink; } -You can also add a favicon. -This, you can find online; there are websites that help you generate a favicon for your site. - -Add a header. +You can also add a favicon. This, you can find online; there are websites that help you generate a favicon. -Create a file header.html, and populate the file with: +Add a header; create a file header.html, and populate the file with: <title> whatever title you want </title> <meta charset="utf-8"> <html lang="en"> - <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link href="style.css" rel="stylesheet" type="text/css" /> Now we add a script to convert the markdown file index.md into an HTML file index.html. -To do so, add a file build.sh containing the following script: +To do so, create a file called build.sh containing the following script: ``` # (c) 2025 w. kennedy @@ -112,7 +114,7 @@ Download Pandoc: $ sudo apt install pandoc -Run the script +Run the script: $ ./build.sh index.md @@ -120,11 +122,11 @@ You should have a file called index.html, check: $ ls -Now that you have index.html, you want to send it to the server. +Now that you have index.html, you want to upload it onto the server. To do so, I use the programme rsync. -We will create a file with the command you need to send your file to the server. +We will create a short script to upload your files to the server, and then you'll use that script to update your website. $ touch deploy.sh @@ -142,8 +144,8 @@ To publish your site to the server, run: $ ./deploy -If you want to add pages to your site, run: +If you want to add pages or other files, e.g. pdf or images, to your site, run: - $ ./deploy page.html + $ ./deploy page.html file.pdf image.png -PS: you might need to edit the template Pandoc uses; I don't remember. If you need to do so, you can find the file default.html5 on the repository of Pandoc, and then customise it. Feel free to email me if you have questions. You can find my email address on the flyers published on https://yctct.compost.party. +PS: you might need to edit the template Pandoc uses; I don't remember if I did so. If you need to do so, you can find the file default.html5 on the repository of Pandoc, and then customise it. Feel free to email me if you have questions. You can find my email address on the flyers published on https://yctct.compost.party. @@ -1,12 +1,13 @@ # How to get your compost.party username -These are the steps I took to get my username set up on compost.party. +These are the steps I took to get setup on compost.party. -- +If you don't have a SSH key, generate a SSH key, to do so run: + Open the application Terminal. -If you don't have a SSH key, generate a SSH key, to do so run: $ ssh-keygen @@ -16,9 +17,9 @@ Copy public key to a file: $ cat ~/.ssh/id_ed25519.pub > ssh_pubkey.txt -The file containing your SSH public key could be name something else, but it ends with <code>.pub</code>. +The file containing your SSH public key could be name something else; it should end with <code>.pub</code>. -Send the the file ssh_pubkey.txt public key to yeah@compost.party. +Send the file ssh_pubkey.txt to yeah@compost.party. Wait for a confirmation from yeah@compost.party that your username has been created. @@ -28,7 +29,9 @@ Connect to the server: $ ssh -p23 username@compost.party -The Terminal should ask you whether it is the right fingerprint. +You should see a message that asks you whether it is the right fingerprint. + +Don't answer that question yet. Copy the fingerprint. @@ -36,7 +39,57 @@ Ask yeah@compost.party whether the fingerprint matches. Once you have received the confirmation that the fingerprint matches, go to your Terminal. -Type <code>yes</code>. +Answer that question; type <code>yes</code>. + +You should be on the server; you should see: + + +``` +welcome to compost.party! + + + ___ ___ ___ + . /\ \ /\ \ /\ \ ___ + / /::\ \ |::\ \ . /::\ \ . /\__\ + / /:/\:\ \ _ |:|:\ \ / /:/\:\ \ / /:/ / + /:/ \:\ \ / __|:|\:\ \ / /:/ \:\ \ / /:/__/ + /:/__/ \:\__\ /::::|_\:\__\ ~ /:/__/ \:\__\ /::\ \ ,~ + \:\ \ \/__/ \:\~~\ \/__/ ~ \:\ \ /:/ / /:/\:\ \ ~ + \:\ \ ~~~~ ___ \:\ \ ~~~ ___ \:\ /:/ / _\/__\:\ \ + \:\ \ ~~ /\ \ \:\ \ ~~ /\ \ \:\/:/ / /\ \ \:\__\ + \:\__\. /::\ \ \:\__\. /::\ \ \::/ / /: \ \ \/__/ + ~ \/__/ /:/\:\ \ \/__/ /:/\:\__\ \/__/ /:/\ \ \ . +· ~ . /:/ \:\ \ /:/ /:/ / _\:\~\ \ \ ~ ·· + ~ ~ /:/__/ \:\__\ /:/_/:/ / ~ ~ /\ \:\ \ \__\ ~ + .\:\ \ /:/ / \:\/:/ / ~ ~ \:\ \:\ \/__/ ~ + .\:\ /:/ / ~ \::/__/ .. ~ \:\ \:\__\ + ~ \:\/:/ /. .~ \:\ \ . . \:\/:/ / ~ + ~ \::/ /. . ~ \:\__\ ~ \::/ / ~. + ~ \/__/ ~ \/_ / ~ \/__/ + ~ ~ . ~ ~ ~ + ~~ ~ ~ ~~ ~~ ~ ~~ ~ ~ ~ ~ + ~ ~ ~ ~ ~ + ~ ~ + . + +the setup of this server is currently in progress. you can put some +static files into your `html` folder, or run a service that you think +is cool. just remember that you share this server with other people +and have fun! + +if you have any questions, don't hesitate to ask (yeah@compost.party) + +username@compost ~ $ +``` + +Read the README: + + $ less README.md + +Next, you can take a look at [the setup I use to upload files to the server](/publish.html). + +-- -You should be on the server. +PS: I created an alias: + $ echo "alias compost='ssh -p23 username@compost.party'" >> ~/.bash_aliases |