From d92d982c1cf4809732e2c1b9882a30e1698acc0e Mon Sep 17 00:00:00 2001 From: Jenniferplusplus Date: Mon, 13 Nov 2023 21:19:45 -0600 Subject: simplify getting started a little and add contributing section --- .gitignore | 1 + readme.md | 8 ++++++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9e5a635 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.backup.* \ No newline at end of file diff --git a/readme.md b/readme.md index f9ed47b..adb07bc 100644 --- a/readme.md +++ b/readme.md @@ -33,7 +33,7 @@ cd Sandcastles ### 2. Initialize the internal root CA ```shell -docker compose run root-ca +docker compose up root-ca -d ``` This will configure the internal Smallstep CA, and will generate a number of secrets that you should maintain. Make a note of the administraive username and password that are printed to the terminal. You may need them in the future, and they cannot be recovered later. If you need to regenerate any of these secrets, you can delete everything in the `./volumes/root-ca/` except the `.gitignore` file. @@ -77,4 +77,8 @@ This requires having the `step` cli installed on your host machine. After this s ### 6. Remove the trusted CA (Optional) If you need to revoke trust in the Sandcastles CA, you can use [Certificate Manager](https://learn.microsoft.com/en-us/dotnet/framework/tools/certmgr-exe-certificate-manager-tool) on Windows. -The linux process is distro specific, try [update-ca-certificates on debian based](https://manpages.ubuntu.com/manpages/xenial/man8/update-ca-certificates.8.html), and [update-ca-trust on red hat based](https://www.redhat.com/sysadmin/configure-ca-trust-list) distributions. \ No newline at end of file +The linux process is distro specific, try [update-ca-certificates on debian based](https://manpages.ubuntu.com/manpages/xenial/man8/update-ca-certificates.8.html), and [update-ca-trust on red hat based](https://www.redhat.com/sysadmin/configure-ca-trust-list) distributions. + +# Contributing + +Please contribute! There's so much fedi software out there! If you build or host some sort of fedi server, it would be so helpful for you to share some configurations that make it easy to spin up a test instance of that software in the sandbox. In the absence of a reference implementation or a test suite, this kind of integration sandbox might be our best resource for building new apps and improving cross-app federation support. \ No newline at end of file -- cgit v1.2.3