2023-07-19 02:43:05 +00:00
# MeMe
MeMe is a privacy-respecting frontend to Know Your Meme
2023-12-10 12:45:29 +00:00
Currently this project is still in development. While it might be in a state where you can host it publicly, There is likely to be many bugs.
2023-07-19 02:43:05 +00:00
# Support
Join our [Matrix room ](https://mto.vern.cc/#/#cobra-frontends:vern.cc ) for support and other things related to MeMe
2023-12-10 17:52:12 +00:00
# Instances
See instances.json
2023-12-14 22:48:13 +00:00
2023-07-19 02:43:05 +00:00
# Run your own instance
## Dependencies
2023-12-10 16:02:34 +00:00
This program is written in Guile Scheme.
2023-12-16 16:43:57 +00:00
You will need need `guile` , `guile-gnutls` , `guile-lib` , and `guile-libxml2` .
`guile-libxml2` is submodule in this repository `libxml2` , `libgumbo` , and `gumbo-libxml` installed.
2023-12-02 23:50:30 +00:00
2023-07-19 02:43:05 +00:00
## Running
2023-12-10 15:53:07 +00:00
1. Clone the repository using `git clone --recurse-submodules http://git.vern.cc/cobra/MeMe`
2023-12-16 16:43:57 +00:00
2. `cd` into `guile-libxml2`
3. Follow the build instructions there
2023-12-10 16:04:22 +00:00
4. `cd` back to the main repo
2023-12-16 16:43:57 +00:00
5. Run `guile -L . -L guile-libxml2 meme.scm`
2023-12-10 16:04:22 +00:00
6. Connect to http://localhost:8003 (or point your reverse proxy to it)
7. Profit
2023-12-10 15:53:07 +00:00
2023-12-14 22:48:13 +00:00
## Environment
2023-12-10 18:25:20 +00:00
`PATCHES_URL` - Link to any patches that were applied. Necessary if there are any. Do not set if there aren't.
The following are optional.
2023-12-10 15:53:07 +00:00
`PORT` - What port to run on (default `8003` ).
2023-12-16 16:43:57 +00:00
`LIBXML2_LOCATION` (Used by guile-libxml2) - Path to `libxml2.so` (default `libxml2` , which checks `LD_LIBRARY_PATH` ).
2023-12-10 15:53:07 +00:00
2023-12-16 16:43:57 +00:00
`GUMBO_LIBXML_LOCATION` (Used by guile-libxml2) - Path to `libgumbo_xml.so` (default `./gumbo-libxml/.libs/libgumbo_xml.so` , can be edited to `libgumbo_xml` , which does the same thing as `libxml2` in `LIBXML2_LOCATION` )
2023-12-03 03:11:38 +00:00
2023-12-15 02:31:43 +00:00
## Notes
When using a service manager (e.g. systemd), make sure the stop signal is set to SIGINT, or 2. This will prevent EADDRINUSE.
2023-12-14 22:48:13 +00:00
# Performance
2023-12-14 23:04:09 +00:00
## Hardware
RAM usage seems to max out below 150 MiB (134 in production testing, different from local, which was around 65 MiB).
## Page
Due to the nature and method of proxying images, the performance on first load is poor (PageSpeed Inisghts speed index of 2.5s).
After the first load, though, your browser's cache control should kick in, and any subsequent requests for an image are cached.
Altogether, the performance listed on PageSpeed Insights is 63.
2023-12-14 22:48:13 +00:00
2023-12-10 05:37:48 +00:00
# Todo
2023-12-14 23:04:09 +00:00
* Speed up image proxying somehow
2023-12-10 17:54:54 +00:00
* Video list page*
* Video page*
* User page (it is internally linked)
2023-12-10 05:37:48 +00:00
2023-12-10 17:54:54 +00:00
\*Videos might not be added because they use embeds from stuff like tiktok and I don't know how to scrape tiktok (use existing proxitok instance?)
2023-12-10 05:37:48 +00:00
2023-12-03 03:11:38 +00:00
# Known issues
1. It's slow
2023-12-10 05:37:48 +00:00
2. It could probably be faster
