Merge pull request #5 from lstein/release/name-change

rename PhotoMap->PhotoMapAI

Author: lstein

docs/configuration.md

@@ -1,18 +1,18 @@
 # Configuration
 
-PhotoMap is primarily configured through the web interface as described in [Basic Usage](user-guide/basic-usage.md#changing-settings) and [Albums](user-guide/albums.md). However, there are a number of runtime parameters that control how the web service behaves.
+PhotoMapAI is primarily configured through the web interface as described in [Basic Usage](user-guide/basic-usage.md#changing-settings) and [Albums](user-guide/albums.md). However, there are a number of runtime parameters that control how the web service behaves.
 
 ## Changing the Web Host and Port
 
-By default, PhotoMap runs its web service on port 8050 and only accepts connections on the local machine (`localhost`). These can be changed on the command line used to launch the application using the `--port` and `--host` options:
+By default, PhotoMapAI runs its web service on port 8050 and only accepts connections on the local machine (`localhost`). These can be changed on the command line used to launch the application using the `--port` and `--host` options:
 
     start_photomap --port 8000 --host 0.0.0.0
 
-This command changes the port to port 8000, and allows PhotoMap to listen for connections on the wildcard IP address `0.0.0.0`, meaning that it will accept connections for any network-accessible location.
+This command changes the port to port 8000, and allows PhotoMapAI to listen for connections on the wildcard IP address `0.0.0.0`, meaning that it will accept connections for any network-accessible location.
 
-If you are using a launcher script to start PhotoMap (e.g. `start_photomap.bat`) you can change these values by opening the script in a text editor (`Notepad` on Windows), finding the line containing `start_photomap`, and adding the options as shown above.
+If you are using a launcher script to start PhotoMapAI (e.g. `start_photomap.bat`) you can change these values by opening the script in a text editor (`Notepad` on Windows), finding the line containing `start_photomap`, and adding the options as shown above.
 
-Alternatively, you can change the port and host interface by setting two environment variables prior to launching PhotoMap. These are:
+Alternatively, you can change the port and host interface by setting two environment variables prior to launching PhotoMapAI. These are:
 
 * `PHOTOMAP_HOST` - the host interface to accept connections from
 * `PHOTOMAP_PORT` - the listen port
@@ -27,16 +27,16 @@ Or you can permanently fix these environment variables by setting them in your s
 
 On Windows systems, setting environment variables can be done through the GUI as well as on the command line. See [How to Set Environment Variables in Windows](https://phoenixnap.com/kb/windows-set-environment-variable) for a good walkthrough.
 
-## Running PhotoMap Under HTTPS
+## Running PhotoMapAI Under HTTPS
 
-By default, PhotoMap runs as a non-secure `HTTP` service. This generates a warning icon in some browsers, but more seriously prevents cut and paste between the PhotoMap tab and browser tabs and desktop applications. 
+By default, PhotoMapAI runs as a non-secure `HTTP` service. This generates a warning icon in some browsers, but more seriously prevents cut and paste between the PhotoMapAI tab and browser tabs and desktop applications. 
 
-There are several ways to enable HTTP for PhotoMap:
+There are several ways to enable HTTP for PhotoMapAI:
 
 ### Install a Self-Signed SSL Certificate
 
 In this method, you generate self-signed encryption certificate and
-private key files and point PhotoMap to them using its `--cert` and
+private key files and point PhotoMapAI to them using its `--cert` and
 `--key` command-line options.
 
 Guides to generating and installing self-signed certificates:
@@ -46,14 +46,14 @@ Guides to generating and installing self-signed certificates:
 - [Creating Self-Signed Certificates with OpenSSL (Mac/Linux)](https://gist.github.com/elklein96/a15090f35a41e16bdc8574a7fb81e119)
 
 These methods will leave you with two files, a .crt certificate file,
-and a .pem key file. Relaunch the PhotoMap server using `--cert
+and a .pem key file. Relaunch the PhotoMapAI server using `--cert
 /path/to/.crt file` and `--key /path/to/.pem file`. If you are using
 the desktop launcher to start the server, simply open the launcher
 file with a text editor, and add the `--cert` and `--key` options to
 the end of the line that ends with `start_photomap`.
 
 After installing the certificate/key pair and relaunching the server,
-you will be able to access the PhotoMap server using the https://
+you will be able to access the PhotoMapAI server using the https://
 URL. Your browser will complain about an unknown certificate authority
 when you first load the URL and ask you to confirm that you trust the site.
 
@@ -64,14 +64,14 @@ browsers automatically trust. It is very easy to use, but it requires that you
 have a web running on port 80 that accepts incoming HTTP connections.
 
 Once the Certbot certificate and keyfile are generated, follow the
-directions in the previous section to configure PhotoMap to use them.
+directions in the previous section to configure PhotoMapAI to use them.
 
 
 ### Use a Reverse Proxy
 
-A final option is to keep PhotoMap running on HTTP, but use a reverse
+A final option is to keep PhotoMapAI running on HTTP, but use a reverse
 proxy from a running web server to translate HTTPS requests on the
-reverse proxy into HTTP requests to PhotoMap. The main advantage of this
+reverse proxy into HTTP requests to PhotoMapAI. The main advantage of this
 is that you get the additional benefit of all the web server's configuration
 controls, such as the ability to add password protection.
 
@@ -89,12 +89,12 @@ You will need to install encryption certificates for the Nginx server using [Cer
 
 This is saying that when a request comes in for
 `https://your.host/photomap/` it will be translated into a request to
-`http://localhost:8050/` where PhotoMap is running. It is possible to
-run the proxy server and the PhotoMap server on separate machines as well.
+`http://localhost:8050/` where PhotoMapAI is running. It is possible to
+run the proxy server and the PhotoMapAI server on separate machines as well.
 
 ## Pointing to an Alternative Configuration File
 
-PhotoMap stores its album definitions and other configuration information in a configuration file. It is not usually necessary to manipulate it directly, but if you wish you can point to an alternative config file in order to have multiple PhotoMap servers each hosting separate album collections.
+PhotoMapAI stores its album definitions and other configuration information in a configuration file. It is not usually necessary to manipulate it directly, but if you wish you can point to an alternative config file in order to have multiple PhotoMapAI servers each hosting separate album collections.
 
 The config file is stored in different places depending on the platform:
 
@@ -104,11 +104,11 @@ The config file is stored in different places depending on the platform:
 | MacOS            | ~/Library/Application Support/photomap/config.yaml |
 | Windows          | C:\Users\<user>\AppData\Roaming\photomap\config.yaml|
 
-To run PhotoMap off a different config file, you may launch it with the `--config` option on the command line, similar to setting the port and host. In the below example we specify an alternative config file named `photomap_2.yaml`
+To run PhotoMapAI off a different config file, you may launch it with the `--config` option on the command line, similar to setting the port and host. In the below example we specify an alternative config file named `photomap_2.yaml`
 
     start_photomap --config ~/photomap_2.yaml
 
-If the indicated config file doesn't exist when you launch PhotoMap, it will be created automatically.
+If the indicated config file doesn't exist when you launch PhotoMapAI, it will be created automatically.
 
 You may also point to an alternative configuration file by setting the environment variable `PHOTOMAP_CONFIG`, as described in the previous section:
 

docs/developer/api.md

@@ -1,6 +1,6 @@
-# PhotoMap API Reference
+# PhotoMapAI API Reference
 
-PhotoMap is driven by a Pydantic data model and a series of FastAPI endpoints. You may access and test these endpoints using [http://localhost:8050/docs](http://localhost:8050/docs)
+PhotoMapAI is driven by a Pydantic data model and a series of FastAPI endpoints. You may access and test these endpoints using [http://localhost:8050/docs](http://localhost:8050/docs)
 
 ## Album Management Endpoints
 

docs/developer/architecture.md

@@ -1,12 +1,12 @@
-# PhotoMap Architecture
+# PhotoMapAI Architecture
 
-PhotoMap is a modular web application designed for efficient photo management, AI-powered search, and interactive visualization. Its architecture is organized into distinct layers and components to ensure scalability, maintainability, and ease of development.
+PhotoMapAI is a modular web application designed for efficient photo management, AI-powered search, and interactive visualization. Its architecture is organized into distinct layers and components to ensure scalability, maintainability, and ease of development.
 
 ---
 
 ## Overview
 
-PhotoMap consists of three main layers:
+PhotoMapAI consists of three main layers:
 
 1. **Frontend**
     - Built with HTML, CSS, and JavaScript (ES6 modules).

docs/developer/frontend.md

@@ -1,6 +1,6 @@
 # Frontend Architecture
 
-The PhotoMap frontend is a modular, responsive web application built with HTML, CSS, and JavaScript (ES6 modules). It provides an interactive user interface for browsing, searching, and visualizing photo collections.
+The PhotoMapAI frontend is a modular, responsive web application built with HTML, CSS, and JavaScript (ES6 modules). It provides an interactive user interface for browsing, searching, and visualizing photo collections.
 
 ---
 

docs/index.md

@@ -1,8 +1,8 @@
-# PhotoMap
+# PhotoMapAI
 
 Rediscover your photo collection!
 
-PhotoMap is a fast, modern image browser and search tool for large photo collections. It supports text and image-based search, semantic clustering, and interactive slideshows with a responsive web interface. Its unique feature is a "semantic map" that clusters and visualizes your images by their content. Browse the semantic map to find and explore thematically-related groups of photos, or use text and/or image similarity search to find specific people, places, events, styles and themes.
+PhotoMapAI is a fast, modern image browser and search tool for large photo collections. It supports text and image-based search, semantic clustering, and interactive slideshows with a responsive web interface. Its unique feature is a "semantic map" that clusters and visualizes your images by their content. Browse the semantic map to find and explore thematically-related groups of photos, or use text and/or image similarity search to find specific people, places, events, styles and themes.
 
 <div class="photomap-overlay-container">
   <img src="img/photomap_slide_with_semantic_map_base.png" width="480" class="photomap-base" alt="Base image">
@@ -21,7 +21,7 @@ PhotoMap is a fast, modern image browser and search tool for large photo collect
 
 ## The Semantic Map
 
-PhotoMap's unique feature is its ability to identify thematically similar images and automatically cluster them, creating a "semantic map":
+PhotoMapAI's unique feature is its ability to identify thematically similar images and automatically cluster them, creating a "semantic map":
 
 <img src="img/photomap_big_semantic_map.png" alt="Big Semantic Map" class="img-hover-zoom">
 
@@ -31,7 +31,7 @@ You can move the semantic map around, shrink it down in size, or hide it altoget
 
 ## Text and Image Similarity Search
 
-PhotoMap lets you search your collection by similarity to another image, by text, or by a combination of image and text as shown below:
+PhotoMapAI lets you search your collection by similarity to another image, by text, or by a combination of image and text as shown below:
 
 <img src="img/photomap_search_interface.png" alt="Big Semantic Map" class="img-hover-zoom">
 
@@ -49,7 +49,7 @@ If you are a user of the [InvokeAI](https://github.com/invoke-ai/InvokeAI) text-
 
 ## Other Features
 
-PhotoMap supports most of the other features you would expect, including support for multiple separate photo albums, the ability to browse photos chronologically, an uncluttered fullscreen mode, and of course a configurable slideshow mode that can show images sequentially or shuffled.
+PhotoMapAI supports most of the other features you would expect, including support for multiple separate photo albums, the ability to browse photos chronologically, an uncluttered fullscreen mode, and of course a configurable slideshow mode that can show images sequentially or shuffled.
 
 ---
 
@@ -60,13 +60,13 @@ PhotoMap supports most of the other features you would expect, including support
 
 #### 1. Download and unpack the source code
 
-Download the PhotoMap source code as a .zip file from the latest stable Releases page. For development versions, use the "Download ZIP" link in the green "Code" button near the top of the GitHub PhotoMap home page.
+Download the PhotoMapAI source code as a .zip file from the latest stable Releases page. For development versions, use the "Download ZIP" link in the green "Code" button near the top of the GitHub PhotoMapAI home page.
 
-Choose a convenient location in your home folder and unzip the file to create a new folder named `PhotoMap`.
+Choose a convenient location in your home folder and unzip the file to create a new folder named `PhotoMapAI`.
 
 #### 2. Run the installer script
 
-Navigate to the unpacked `PhotoMap` folder, find the `INSTALL` folder, and double-click the `install_windows` script file. The system will check that Python and other requirements are installed, download the necessary library files, and create a .bat script named `start_photomap`.
+Navigate to the unpacked `PhotoMapAI` folder, find the `INSTALL` folder, and double-click the `install_windows` script file. The system will check that Python and other requirements are installed, download the necessary library files, and create a .bat script named `start_photomap`.
 
 #### 3. Start the server
 
@@ -82,13 +82,13 @@ Double-click `start_photomap.bat` to launch the server. You should see a few sta
 
 #### 1. Download and unpack the source code
 
-Download the PhotoMap source code as a .zip file from the latest stable Releases page. For development versions, use the "Download ZIP" link in the green "Code" button near the top of the GitHub PhotoMap home page.
+Download the PhotoMapAI source code as a .zip file from the latest stable Releases page. For development versions, use the "Download ZIP" link in the green "Code" button near the top of the GitHub PhotoMapAI home page.
 
-Choose a convenient location in your home directory and unzip the file to create a new folder named `PhotoMap`.
+Choose a convenient location in your home directory and unzip the file to create a new folder named `PhotoMapAI`.
 
 #### 2. Run the installer script
 
-Navigate to the `PhotoMap` folder and launch the `install_linux_mac` shell script file. The script will check that Python and other requirements are installed, download the necessary library files, and create a launcher script named `start_photomap` on your desktop.
+Navigate to the `PhotoMapAI` folder and launch the `install_linux_mac` shell script file. The script will check that Python and other requirements are installed, download the necessary library files, and create a launcher script named `start_photomap` on your desktop.
 
 #### 3. Start the server