amy/amsterdam
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 3 Wiki Activity

update README and TODO

Browse Source
This commit is contained in:
Amy G. Bowersox
2026-04-17 19:46:08 -05:00
parent 8c1fa9ebdc
commit 70dcf82234
2 changed files with 7 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -7
View File
@@ -114,14 +114,9 @@ in your `PATH`. Then run `go generate` to regenerate the CSS file before you run
## Installing Amsterdam ## Installing Amsterdam
You will need a MySQL database to store Amsterdam data. Create a new empty database, then, from the command line, use the command: You will need a MySQL database to store Amsterdam data. Create a new empty database.
> `mysql -u root -p _databasename_ \< setup/mysql-database.sql` Ensure a user in your database is granted all privileges to all tables in your new database.
(Replace _databasename_ with the name of your database. If you use a user other than `root` for administrative access to your
MySQL server, use that.)
Ensure a user in your database is granted SELECT, INSERT, UPDATE, and DELETE privileges to all tables in your new database.
This is the user that you will configure Amsterdam to use. This is the user that you will configure Amsterdam to use.
The database may be specified to Amsterdam with the following command line options or environment variables: The database may be specified to Amsterdam with the following command line options or environment variables:
@@ -133,6 +128,8 @@ The database may be specified to Amsterdam with the following command line optio
All these options may also be specified via the configuration file (see below). All these options may also be specified via the configuration file (see below).
The first time you execute Amsterdam, the necessary database tables will be created and populated.
Amsterdam also requires access to a local SMTP server, as it sends out E-mail messages such as account verification, Amsterdam also requires access to a local SMTP server, as it sends out E-mail messages such as account verification,
password reminders, subscribed posts, and messages from conference or community hosts. It may be specified to Amsterdam password reminders, subscribed posts, and messages from conference or community hosts. It may be specified to Amsterdam
with the following command line options or environment variables: with the following command line options or environment variables:
TODO.md
+3 -3
View File
@@ -14,9 +14,9 @@ After the point where it reaches feature parity with Venice circa 2006.
## Immediate Cleanups Required ## Immediate Cleanups Required
* A better way to set up the database than `setup/database.sql`. Bring the table setup into the application somehow. * <s>A better way to set up the database than `setup/database.sql`. Bring the table setup into the application somehow.
The [migrate](https://github.com/golang-migrate/migrate) library might be of use here. The [migrate](https://github.com/golang-migrate/migrate) library might be of use here.</s>
* Database format migrations. * ~~Database format migrations.~~
* Allow use of Postgres as a database. * Allow use of Postgres as a database.
* Dockerization. * Dockerization.
* Implement proper help and online documentation. * Implement proper help and online documentation.